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.
TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
TagKey:
type: string
pattern: ^.*$
minLength: 1
maxLength: 128
ThrottlingException: {}
ResourceStatus:
type: string
enum:
- ACTIVE
- DELETING
Certificates:
type: array
items:
$ref: '#/components/schemas/TlsCertificateData'
Description:
type: string
pattern: ^.*$
maxLength: 512
StatusReason:
type: string
pattern: ^[a-zA-Z0-9- ]+$
minLength: 1
maxLength: 256
InvalidRequestException: {}
ResourceId:
type: string
pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$
minLength: 36
maxLength: 36
CollectionMember_String:
type: string
InvalidOperationException: {}
LastUpdateTime:
type: string
format: date-time
InternalServerError: {}
EncryptionConfiguration:
type: object
required:
- Type
properties:
KeyId:
allOf:
- $ref: '#/components/schemas/KeyId'
- description: The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
Type:
allOf:
- $ref: '#/components/schemas/EncryptionType'
- description: The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
description: A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
KeyId:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 2048
EncryptionType:
type: string
enum:
- CUSTOMER_KMS
- AWS_OWNED_KMS_KEY
ResourceName:
type: string
pattern: ^[a-zA-Z0-9-]+$
minLength: 1
maxLength: 128
ResourceArn:
type: string
pattern: ^arn:aws.*
minLength: 1
maxLength: 256
Tag:
type: object
required:
- Key
- Value
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
description: 'A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each Amazon Web Services resource. '
NumberOfAssociations:
type: integer
DeleteTLSInspectionConfigurationResponse:
type: object
required:
- TLSInspectionConfigurationResponse
properties:
TLSInspectionConfigurationResponse:
allOf:
- $ref: '#/components/schemas/TLSInspectionConfigurationResponse'
- description: 'The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration. '
TagValue:
type: string
pattern: ^.*$
minLength: 0
maxLength: 256
DeleteTLSInspectionConfigurationRequest:
type: object
title: DeleteTLSInspectionConfigurationRequest
properties:
TLSInspectionConfigurationArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the TLS inspection configuration.
You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationName: allOf: - $ref: '#/components/schemas/ResourceName' - description:The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
You must specify the ARN or the name, and you can specify both.
TagList: type: array items: $ref: '#/components/schemas/Tag' minItems: 1 maxItems: 200 TlsCertificateData: type: object properties: CertificateArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of the certificate. CertificateSerial: allOf: - $ref: '#/components/schemas/CollectionMember_String' - description: The serial number of the certificate. Status: allOf: - $ref: '#/components/schemas/CollectionMember_String' - description: The status of the certificate. StatusMessage: allOf: - $ref: '#/components/schemas/StatusReason' - description: Contains details about the certificate status, including information about certificate errors. description: Contains metadata about an Certificate Manager certificate. parameters: X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/network-firewall/ x-hasEquivalentPaths: true