@aws-sdk/client-network-firewall

Description

AWS SDK for JavaScript NetworkFirewall Client for Node.js, Browser and React Native.

This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors. The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the Amazon Web Services REST APIs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a>. To view the complete list of Amazon Web Services Regions where Network Firewall is available, see <a href="https://docs.aws.amazon.com/general/latest/gr/network-firewall.html">Service endpoints and quotas</a> in the Amazon Web Services General Reference. To access Network Firewall using the IPv4 REST API endpoint: <code>https://network-firewall.<region>.amazonaws.com </code> To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint: <code>https://network-firewall.<region>.aws.api </code> Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>. For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/">Network Firewall Developer Guide</a>. Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source network analysis and threat detection engine. Network Firewall supports Suricata version 7.0.3. For information about Suricata, see the <a href="https://suricata.io/">Suricata website</a> and the <a href="https://suricata.readthedocs.io/en/suricata-7.0.3/">Suricata User Guide</a>. You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: <ul> <li> Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic. </li> <li> Use custom lists of known bad domains to limit the types of domain names that your applications can access. </li> <li> Perform deep packet inspection on traffic entering or leaving your VPC. </li> <li> Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used. </li> </ul> To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/">Amazon VPC User Guide</a>. To start using Network Firewall, do the following: <ol> <li> (Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC. </li> <li> In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall. </li> <li> In Network Firewall, define the firewall behavior as follows: <ol> <li> Create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have. </li> <li> Create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </li> </ol> </li> <li> In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy. </li> <li> In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints. </li> </ol> After your firewall is established, you can add firewall endpoints for new Availability Zones by following the prior steps for the Amazon VPC setup and firewall subnet definitions. You can also add endpoints to Availability Zones that you're using in the firewall, either for the same VPC or for another VPC, by following the prior steps for the Amazon VPC setup, and defining the new VPC subnets as VPC endpoint associations.

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-network-firewall
yarn add @aws-sdk/client-network-firewall
pnpm add @aws-sdk/client-network-firewall

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the NetworkFirewallClient and the commands you need, for example ListProxiesCommand:

// ES5 example
const { NetworkFirewallClient, ListProxiesCommand } = require("@aws-sdk/client-network-firewall");

// ES6+ example
import { NetworkFirewallClient, ListProxiesCommand } from "@aws-sdk/client-network-firewall";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new NetworkFirewallClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListProxiesCommand(params);

Async/await

We recommend using the await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

NetworkFirewall extends NetworkFirewallClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (NetworkFirewallClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { NetworkFirewall } from "@aws-sdk/client-network-firewall";

const client = new NetworkFirewall({ region: "REGION" });

// async/await.
try {
  const data = await client.listProxies(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listProxies(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listProxies(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-network-firewall package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

<details> <summary> AcceptNetworkFirewallTransitGatewayAttachment </summary>