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.
Creates the firewall policy for the firewall according to the specifications.
An Network Firewall firewall policy defines the behavior of a firewall, in a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateFirewallPolicyResponse' examples: CreateFirewallPolicy200Example: summary: Default CreateFirewallPolicy 200 response x-microcks-default: true value: UpdateToken: example-string FirewallPolicyResponse: example-string '480': description: LimitExceededException content: application/json: schema: $ref: '#/components/schemas/LimitExceededException' '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServerError content: application/json: schema: $ref: '#/components/schemas/InternalServerError' '484': description: InsufficientCapacityException content: application/json: schema: $ref: '#/components/schemas/InsufficientCapacityException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFirewallPolicyRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - NetworkFirewall_20201112.CreateFirewallPolicy x-microcks-operation: delay: 0 dispatcher: FALLBACK summary: Amazon Network Firewall Create Firewall Policy tags: - '#X Amz Target=NetworkFirewall 20201112.CreateFirewallPolicy' components: schemas: RuleCapacity: type: integer TagKey: type: string pattern: ^.*$ minLength: 1 maxLength: 128 Priority: type: integer minimum: 1 maximum: 65535 ThrottlingException: {} CustomAction: type: object required: - ActionName - ActionDefinition properties: ActionName: allOf: - $ref: '#/components/schemas/ActionName' - description: The descriptive name of the custom action. You can't change the name of a custom action after you create it. ActionDefinition: allOf: - $ref: '#/components/schemas/ActionDefinition' - description: The custom action associated with the action name. description: 'An optional, non-standard action to use for stateless packet handling. You can define this in addition to the standard action that you must specify.
You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.
You can use custom actions in the following places:
In a rule group''s StatelessRulesAndCustomActions specification. The custom actions are available for use by name inside the StatelessRulesAndCustomActions where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule''s match attributes.
In a FirewallPolicy specification, in StatelessCustomActions. The custom actions are available for use inside the policy where you define them. You can use them for the policy''s default stateless actions settings to specify what to do with packets that don''t match any of the policy''s stateless rules.
DROP to ALERT. This only applies to managed rule groups.
description: 'The setting that allows the policy owner to change the behavior of the rule group within a policy. '
Description:
type: string
pattern: ^.*$
maxLength: 512
FirewallPolicyResponse:
type: object
required:
- FirewallPolicyName
- FirewallPolicyArn
- FirewallPolicyId
properties:
FirewallPolicyName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
FirewallPolicyArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the firewall policy.
If this response is for a create request that had DryRun set to TRUE, then this ARN is a placeholder that isn't attached to a valid resource.
An integer setting that indicates the order in which to run the stateful rule groups in a single FirewallPolicy. This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.
Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.
You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.
Override: allOf: - $ref: '#/components/schemas/StatefulRuleGroupOverride' - description: The action that allows the policy owner to override the behavior of the rule group within a policy. description: 'Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group. ' 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 LastUpdateTime: type: string format: date-time StatelessRuleGroupReference: type: object required: - ResourceArn - Priority properties: ResourceArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of the stateless rule group. Priority: allOf: - $ref: '#/components/schemas/Priority' - description: An integer setting that indicates the order in which to run the stateless rule groups in a single FirewallPolicy. Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. description: 'Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group. ' InternalServerError: {} LimitExceededException: {} Boolean: type: boolean 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. CreateFirewallPolicyResponse: type: object required: - UpdateToken - FirewallPolicyResponse properties: UpdateToken: allOf: - $ref: '#/components/schemas/UpdateToken' - description:A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. This setting defines a CloudWatch dimension value to be published.
You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it.
description: A custom action to use in stateless rule actions settings. This is used in CustomAction. ActionName: type: string pattern: ^[a-zA-Z0-9]+$ minLength: 1 maxLength: 128 StatelessActions: type: array items: $ref: '#/components/schemas/CollectionMember_String' StatelessRuleGroupReferences: type: array items: $ref: '#/components/schemas/StatelessRuleGroupReference' KeyId: type: string pattern: .*\S.* minLength: 1 maxLength: 2048 EncryptionType: type: string enum: - CUSTOMER_KMS - AWS_OWNED_KMS_KEY StreamExceptionPolicy: type: string enum: - DROP - CONTINUE DimensionValue: type: string pattern: ^[a-zA-Z0-9-_ ]+$ minLength: 1 maxLength: 128 RuleOrder: type: string enum: - DEFAULT_ACTION_ORDER - STRICT_ORDER UpdateToken: type: string pattern: ^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$ minLength: 1 maxLength: 1024 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 InsufficientCapacityException: {} StatefulRuleGroupReferences: type: array items: $ref: '#/components/schemas/StatefulRuleGroupReference' StatefulActions: type: array items: $ref: '#/components/schemas/CollectionMember_String' TagValue: type: string pattern: ^.*$ minLength: 0 maxLength: 256 OverrideAction: type: string enum: - DROP_TO_ALERT TagList: type: array items: $ref: '#/components/schemas/Tag' minItems: 1 maxItems: 200 Dimension: type: object required: - Value properties: Value: allOf: - $ref: '#/components/schemas/DimensionValue' - description: The value to use in the custom metric dimension. description:The value to use in an Amazon CloudWatch custom metric dimension. This is used in the PublishMetrics CustomAction. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
Network Firewall sets the dimension name to CustomAction and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User Guide.
StatefulEngineOptions: type: object properties: RuleOrder: allOf: - $ref: '#/components/schemas/RuleOrder' - description: 'Indicates how to manage the order of stateful rule evaluation for the policy.DEFAULT_ACTION_ORDER is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see Evaluation order for stateful rules in the Network Firewall Developer Guide. '
StreamExceptionPolicy:
allOf:
- $ref: '#/components/schemas/StreamExceptionPolicy'
- description: Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
The actions to take on a packet if it doesn''t match any of the stateless rules in the policy. If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.
For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
The actions to take on a fragmented UDP packet if it doesn''t match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify aws:forward_to_sfe.
You must specify one of the standard actions: aws:pass, aws:drop, or aws:forward_to_sfe. In addition, you can specify custom actions that are compatible with your standard section choice.
For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”]. For information about compatibility, see the custom action descriptions under CustomAction.
StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.
StatefulRuleGroupReferences:
allOf:
- $ref: '#/components/schemas/StatefulRuleGroupReferences'
- description: 'References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules. '
StatefulDefaultActions:
allOf:
- $ref: '#/components/schemas/StatefulActions'
- description: The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, and is only valid when using the strict rule order.
Valid values of the stateful default action:
aws:drop_strict
aws:drop_established
aws:alert_strict
aws:alert_established
For more information, see Strict evaluation order in the Network Firewall Developer Guide.
StatefulEngineOptions: allOf: - $ref: '#/components/schemas/StatefulEngineOptions' - description: Additional options governing how Network Firewall handles stateful rules. The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings. TLSInspectionConfigurationArn: allOf: - $ref: '#/components/schemas/ResourceArn' - description: The Amazon Resource Name (ARN) of the TLS inspection configuration. description:The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.
This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
CreateFirewallPolicyRequest: type: object required: - FirewallPolicyName - FirewallPolicy title: CreateFirewallPolicyRequest properties: FirewallPolicyName: allOf: - $ref: '#/components/schemas/ResourceName' - description: The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it. FirewallPolicy: allOf: - $ref: '#/components/schemas/FirewallPolicy' - description: The rule groups and policy actions to use in the firewall policy. Description: allOf: - $ref: '#/components/schemas/Description' - description: A description of the firewall policy. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: The key:value pairs to associate with the resource. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description:Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have the required permissions to run the request and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.