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 access Network Firewall using the REST API endpoint: https://network-firewall.<region>.amazonaws.com
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 6.0.9. For information about Suricata, see the Suricata website.
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, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have.
In Network Firewall, 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.
Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans.
This request creates an Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AssociateSubnetsResponse' examples: AssociateSubnets200Example: summary: Default AssociateSubnets 200 response x-microcks-default: true value: FirewallArn: arn:aws:service:us-east-1:123456789012:resource/example FirewallName: my-resource SubnetMappings: example-string UpdateToken: example-string '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/InternalServerError' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InvalidTokenException content: application/json: schema: $ref: '#/components/schemas/InvalidTokenException' '485': description: InvalidOperationException content: application/json: schema: $ref: '#/components/schemas/InvalidOperationException' '486': description: InsufficientCapacityException content: application/json: schema: $ref: '#/components/schemas/InsufficientCapacityException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssociateSubnetsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - NetworkFirewall_20201112.AssociateSubnets x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Network Firewall Associate Subnets tags: - '#X Amz Target=NetworkFirewall 20201112.AssociateSubnets' components: schemas: ResourceNotFoundException: {} ThrottlingException: {} InvalidRequestException: {} InvalidOperationException: {} CollectionMember_String: type: string InternalServerError: {} AssociateSubnetsRequest: type: object required: - SubnetMappings title: AssociateSubnetsRequest properties: UpdateToken: allOf: - $ref: '#/components/schemas/UpdateToken' - description:An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
The Amazon Resource Name (ARN) of the firewall.
You must specify the ARN or the name, and you can specify both.
FirewallName: allOf: - $ref: '#/components/schemas/ResourceName' - description:The descriptive name of the firewall. You can't change the name of a firewall after you create it.
You must specify the ARN or the name, and you can specify both.
SubnetMappings: allOf: - $ref: '#/components/schemas/SubnetMappings' - description: 'The IDs of the subnets that you want to associate with the firewall. ' UpdateToken: type: string pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$ minLength: 1 maxLength: 1024 IPAddressType: type: string enum: - DUALSTACK - IPV4 - IPV6 ResourceName: type: string pattern: ^[a-zA-Z0-9-]+$ minLength: 1 maxLength: 128 ResourceArn: type: string pattern: ^arn:aws.* minLength: 1 maxLength: 256 SubnetMappings: type: array items: $ref: '#/components/schemas/SubnetMapping' InsufficientCapacityException: {} InvalidTokenException: {} SubnetMapping: type: object required: - SubnetId properties: SubnetId: allOf: - $ref: '#/components/schemas/CollectionMember_String' - description: 'The unique identifier for the subnet. ' IPAddressType: allOf: - $ref: '#/components/schemas/IPAddressType' - description: The subnet's IP address type. You can't change the IP address type after you create the subnet. description: The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone. AssociateSubnetsResponse: type: object properties: FirewallArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of the firewall. FirewallName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The descriptive name of the firewall. You can't change the name of a firewall after you create it. SubnetMappings: allOf: - $ref: '#/components/schemas/SubnetMappings' - description: 'The IDs of the subnets that are associated with the firewall. ' UpdateToken: allOf: - $ref: '#/components/schemas/UpdateToken' - description:An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.