AWS SDK for JavaScript Network Firewall Client for Node.js, Browser and React Native
npm install @aws-sdk/client-network-firewallAWS 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 Amazon Web Services APIs.
To view the complete list of Amazon Web Services Regions where Network Firewall is available, see
Service
endpoints and quotas in the Amazon Web Services General
Reference.
To access Network Firewall using the IPv4 REST API endpoint:https://network-firewall.
To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint:https://network-firewall.
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
Amazon Web Services SDKs.
For descriptions of Network Firewall features, including and step-by-step
instructions on how to use them through the Network Firewall console, see the Network Firewall Developer
Guide.
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 Suricata website and the
Suricata User Guide.
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways.
The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and
block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your
applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the
port used.
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 Amazon VPC User Guide.
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in
Amazon VPC.
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.
In Network Firewall, define the firewall behavior as follows:
Create stateless and stateful rule groups,
to define the components of the network traffic filtering behavior that you want your firewall to have.
Create a firewall policy that uses your rule groups and
specifies additional default traffic filtering behavior.
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.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall
endpoints.
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.
npm install @aws-sdk/client-network-firewallyarn add @aws-sdk/client-network-firewallpnpm add @aws-sdk/client-network-firewallThe 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:
``js`
// ES5 example
const { NetworkFirewallClient, ListProxiesCommand } = require("@aws-sdk/client-network-firewall");
`ts`
// ES6+ example
import { NetworkFirewallClient, ListProxiesCommand } from "@aws-sdk/client-network-firewall";
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new NetworkFirewallClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListProxiesCommand(params);
`
#### Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
`js`
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
#### Promises
You can also use Promise chaining
to execute send operation.
`js`
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
`js`
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
#### Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
`js`
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
#### v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
`ts
import * as AWS from "@aws-sdk/client-network-firewall";
const client = new AWS.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.
client.listProxies(params, (err, data) => {
// process err and data.
});
`
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
`js`
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;
* }
*/
}
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
- Visit 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.
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.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
AcceptNetworkFirewallTransitGatewayAttachment
Command API Reference / Input / Output
AssociateAvailabilityZones
Command API Reference / Input / Output
AssociateFirewallPolicy
Command API Reference / Input / Output
AssociateSubnets
Command API Reference / Input / Output
AttachRuleGroupsToProxyConfiguration
Command API Reference / Input / Output
CreateFirewall
Command API Reference / Input / Output
CreateFirewallPolicy
Command API Reference / Input / Output
CreateProxy
Command API Reference / Input / Output
CreateProxyConfiguration
Command API Reference / Input / Output
CreateProxyRuleGroup
Command API Reference / Input / Output
CreateProxyRules
Command API Reference / Input / Output
CreateRuleGroup
Command API Reference / Input / Output
CreateTLSInspectionConfiguration
Command API Reference / Input / Output
CreateVpcEndpointAssociation
Command API Reference / Input / Output
DeleteFirewall
Command API Reference / Input / Output
DeleteFirewallPolicy
Command API Reference / Input / Output
DeleteNetworkFirewallTransitGatewayAttachment
Command API Reference / Input / Output
DeleteProxy
Command API Reference / Input / Output
DeleteProxyConfiguration
Command API Reference / Input / Output
DeleteProxyRuleGroup
Command API Reference / Input / Output
DeleteProxyRules
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeleteRuleGroup
Command API Reference / Input / Output
DeleteTLSInspectionConfiguration
Command API Reference / Input / Output
DeleteVpcEndpointAssociation
Command API Reference / Input / Output
DescribeFirewall
Command API Reference / Input / Output
DescribeFirewallMetadata
Command API Reference / Input / Output
DescribeFirewallPolicy
Command API Reference / Input / Output
DescribeFlowOperation
Command API Reference / Input / Output
DescribeLoggingConfiguration
Command API Reference / Input / Output
DescribeProxy
Command API Reference / Input / Output
DescribeProxyConfiguration
Command API Reference / Input / Output
DescribeProxyRule
Command API Reference / Input / Output
DescribeProxyRuleGroup
Command API Reference / Input / Output
DescribeResourcePolicy
Command API Reference / Input / Output
DescribeRuleGroup
Command API Reference / Input / Output
DescribeRuleGroupMetadata
Command API Reference / Input / Output
DescribeRuleGroupSummary
Command API Reference / Input / Output
DescribeTLSInspectionConfiguration
Command API Reference / Input / Output
DescribeVpcEndpointAssociation
Command API Reference / Input / Output
DetachRuleGroupsFromProxyConfiguration
Command API Reference / Input / Output
DisassociateAvailabilityZones
Command API Reference / Input / Output
DisassociateSubnets
Command API Reference / Input / Output
GetAnalysisReportResults
Command API Reference / Input / Output
ListAnalysisReports
Command API Reference / Input / Output
ListFirewallPolicies
Command API Reference / Input / Output
ListFirewalls
Command API Reference / Input / Output
ListFlowOperationResults
Command API Reference / Input / Output
ListFlowOperations
Command API Reference / Input / Output
ListProxies
Command API Reference / Input / Output
ListProxyConfigurations
Command API Reference / Input / Output
ListProxyRuleGroups
Command API Reference / Input / Output
ListRuleGroups
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListTLSInspectionConfigurations
Command API Reference / Input / Output
ListVpcEndpointAssociations
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
RejectNetworkFirewallTransitGatewayAttachment
Command API Reference / Input / Output
StartAnalysisReport
Command API Reference / Input / Output
StartFlowCapture
Command API Reference / Input / Output
StartFlowFlush
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateAvailabilityZoneChangeProtection
Command API Reference / Input / Output
UpdateFirewallAnalysisSettings
Command API Reference / Input / Output
UpdateFirewallDeleteProtection
Command API Reference / Input / Output
UpdateFirewallDescription
Command API Reference / Input / Output
UpdateFirewallEncryptionConfiguration
Command API Reference / Input / Output
UpdateFirewallPolicy
Command API Reference / Input / Output
UpdateFirewallPolicyChangeProtection
Command API Reference / Input / Output
UpdateLoggingConfiguration
Command API Reference / Input / Output
UpdateProxy
Command API Reference / Input / Output
UpdateProxyConfiguration
Command API Reference / Input / Output
UpdateProxyRule
Command API Reference / Input / Output
UpdateProxyRuleGroupPriorities
Command API Reference / Input / Output
UpdateProxyRulePriorities
Command API Reference / Input / Output
UpdateRuleGroup
Command API Reference / Input / Output
UpdateSubnetChangeProtection
Command API Reference / Input / Output
UpdateTLSInspectionConfiguration