The #X Amz Target=NetworkFirewall 20201112.DescribeFirewallPolicy API from Amazon Network Firewall — 1 operation(s) for #x amz target=networkfirewall 20201112.describefirewallpolicy.
openapi: 3.0.0
info:
version: 2020-11-12
x-release: v4
title: 'AWS Network Firewall #X Amz Target=NetworkFirewall 20201112.AssociateFirewallPolicy #X Amz Target=NetworkFirewall 20201112.AssociateFirewallPolicy #X Amz Target=NetworkFirewall 20201112.DescribeFirewallPolicy API'
description: '<p>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. </p> <ul> <li> <p>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>. </p> <p>To access Network Firewall using the REST API endpoint: <code>https://network-firewall.<region>.amazonaws.com </code> </p> </li> <li> <p>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>.</p> </li> <li> <p>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>.</p> </li> </ul> <p>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 <a href="https://suricata.io/">Suricata website</a>.</p> <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: </p> <ul> <li> <p>Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and block all other forms of traffic.</p> </li> <li> <p>Use custom lists of known bad domains to limit the types of domain names that your applications can access.</p> </li> <li> <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p> </li> <li> <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.</p> </li> </ul> <p>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>.</p> <p>To start using Network Firewall, do the following: </p> <ol> <li> <p>(Optional) If you don''t already have a VPC that you want to protect, create it in Amazon VPC. </p> </li> <li> <p>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. </p> </li> <li> <p>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. </p> </li> <li> <p>In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </p> </li> <li> <p>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.</p> </li> <li> <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.</p> </li> </ol>'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: network-firewall
x-aws-signingName: network-firewall
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/network-firewall-2020-11-12.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://network-firewall.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Network Firewall multi-region endpoint
- url: https://network-firewall.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Network Firewall multi-region endpoint
- url: http://network-firewall.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
- url: https://network-firewall.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Network Firewall endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=NetworkFirewall 20201112.DescribeFirewallPolicy'
paths:
/#X-Amz-Target=NetworkFirewall_20201112.DescribeFirewallPolicy:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeFirewallPolicy
description: 'Returns the data objects for the specified firewall policy. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeFirewallPolicyResponse'
examples:
DescribeFirewallPolicy200Example:
summary: Default DescribeFirewallPolicy 200 response
x-microcks-default: true
value:
UpdateToken: example-string
FirewallPolicyResponse: example-string
FirewallPolicy: example-string
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'483':
description: InternalServerError
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerError'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeFirewallPolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- NetworkFirewall_20201112.DescribeFirewallPolicy
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
summary: Amazon Network Firewall Describe Firewall Policy
tags:
- '#X Amz Target=NetworkFirewall 20201112.DescribeFirewallPolicy'
components:
schemas:
ResourceNotFoundException: {}
PublishMetricAction:
type: object
required:
- Dimensions
properties:
Dimensions:
allOf:
- $ref: '#/components/schemas/Dimensions'
- description: <p/>
description: 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.
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: '<p>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. </p> <p>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. </p> <p>You can use custom actions in the following places: </p> <ul> <li> <p>In a rule group''s <a>StatelessRulesAndCustomActions</a> specification. The custom actions are available for use by name inside the <code>StatelessRulesAndCustomActions</code> 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. </p> </li> <li> <p>In a <a>FirewallPolicy</a> specification, in <code>StatelessCustomActions</code>. 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. </p> </li> </ul>'
ResourceStatus:
type: string
enum:
- ACTIVE
- DELETING
Dimensions:
type: array
items:
$ref: '#/components/schemas/Dimension'
minItems: 1
maxItems: 1
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: <p>The Amazon Resource Name (ARN) of the firewall policy.</p> <note> <p>If this response is for a create request that had <code>DryRun</code> set to <code>TRUE</code>, then this ARN is a placeholder that isn't attached to a valid resource.</p> </note>
FirewallPolicyId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier for the firewall policy. '
Description:
allOf:
- $ref: '#/components/schemas/Description'
- description: A description of the firewall policy.
FirewallPolicyStatus:
allOf:
- $ref: '#/components/schemas/ResourceStatus'
- description: The current status of the firewall policy. You can retrieve this for a firewall policy by calling <a>DescribeFirewallPolicy</a> and providing the firewall policy's name or ARN.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The key:value pairs to associate with the resource.
ConsumedStatelessRuleCapacity:
allOf:
- $ref: '#/components/schemas/RuleCapacity'
- description: The number of capacity units currently consumed by the policy's stateless rules.
ConsumedStatefulRuleCapacity:
allOf:
- $ref: '#/components/schemas/RuleCapacity'
- description: The number of capacity units currently consumed by the policy's stateful rules.
NumberOfAssociations:
allOf:
- $ref: '#/components/schemas/NumberOfAssociations'
- description: The number of firewalls that are associated with this firewall policy.
EncryptionConfiguration:
allOf:
- $ref: '#/components/schemas/EncryptionConfiguration'
- description: A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
LastModifiedTime:
allOf:
- $ref: '#/components/schemas/LastUpdateTime'
- description: The last time that the firewall policy was changed.
description: 'The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. '
StatefulRuleGroupOverride:
type: object
properties:
Action:
allOf:
- $ref: '#/components/schemas/OverrideAction'
- description: The action that changes the rule group from <code>DROP</code> to <code>ALERT</code>. 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. '
StatefulRuleGroupReference:
type: object
required:
- ResourceArn
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: The Amazon Resource Name (ARN) of the stateful rule group.
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: <p>An integer setting that indicates the order in which to run the stateful rule groups in a single <a>FirewallPolicy</a>. This setting only applies to firewall policies that specify the <code>STRICT_ORDER</code> rule order in the stateful engine options settings.</p> <p>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.</p> <p>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. </p>
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 <a>FirewallPolicy</a>. 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: {}
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 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key ID</a> in the <i>Amazon Web Services KMS Developer Guide</i>.
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 <a href="https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html">Encryption at rest with Amazon Web Services Key Managment Service</a> in the <i>Network Firewall Developer Guide</i>.
KeyId:
type: string
pattern: .*\S.*
minLength: 1
maxLength: 2048
DescribeFirewallPolicyResponse:
type: object
required:
- UpdateToken
- FirewallPolicyResponse
properties:
UpdateToken:
allOf:
- $ref: '#/components/schemas/UpdateToken'
- description: <p>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. </p> <p>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 <code>InvalidTokenException</code>. 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. </p>
FirewallPolicyResponse:
allOf:
- $ref: '#/components/schemas/FirewallPolicyResponse'
- description: 'The high-level properties of a firewall policy. This, along with the <a>FirewallPolicy</a>, define the policy. You can retrieve all objects for a firewall policy by calling <a>DescribeFirewallPolicy</a>. '
FirewallPolicy:
allOf:
- $ref: '#/components/schemas/FirewallPolicy'
- description: 'The policy for the specified firewall policy. '
ActionDefinition:
type: object
properties:
PublishMetricAction:
allOf:
- $ref: '#/components/schemas/PublishMetricAction'
- description: <p>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.</p> <p>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. </p>
description: A custom action to use in stateless rule actions settings. This is used in <a>CustomAction</a>.
ActionName:
type: string
pattern: ^[a-zA-Z0-9]+$
minLength: 1
maxLength: 128
StatelessActions:
type: array
items:
$ref: '#/components/schemas/CollectionMember_String'
EncryptionType:
type: string
enum:
- CUSTOMER_KMS
- AWS_OWNED_KMS_KEY
StatelessRuleGroupReferences:
type: array
items:
$ref: '#/components/schemas/StatelessRuleGroupReference'
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
StatefulActions:
type: array
items:
$ref: '#/components/schemas/CollectionMember_String'
StatefulRuleGroupReferences:
type: array
items:
$ref: '#/components/schemas/StatefulRuleGroupReference'
DescribeFirewallPolicyRequest:
type: object
title: DescribeFirewallPolicyRequest
properties:
FirewallPolicyName:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: <p>The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
FirewallPolicyArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- description: <p>The Amazon Resource Name (ARN) of the firewall policy.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
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: <p>The value to use in an Amazon CloudWatch custom metric dimension. This is used in the <code>PublishMetrics</code> <a>CustomAction</a>. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric. </p> <p>Network Firewall sets the dimension name to <code>CustomAction</code> and you provide the dimension value. </p> <p>For more information about CloudWatch custom metric dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions">Publishing Custom Metrics</a> in the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html">Amazon CloudWatch User Guide</a>.</p>
StatefulEngineOptions:
type: object
properties:
RuleOrder:
allOf:
- $ref: '#/components/schemas/RuleOrder'
- description: 'Indicates how to manage the order of stateful rule evaluation for the policy. <code>DEFAULT_ACTION_ORDER</code> 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 <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html">Evaluation order for stateful rules</a> in the <i>Network Firewall Developer Guide</i>. '
StreamExceptionPolicy:
allOf:
- $ref: '#/components/schemas/StreamExceptionPolicy'
- description: <p>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.</p> <ul> <li> <p> <code>DROP</code> - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.</p> </li> <li> <p> <code>CONTINUE</code> - 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 <code>drop http</code> 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 <code>flow:stateless</code> rule would still match, as would the <code>aws:drop_strict</code> default action.</p> </li> </ul>
description: 'Configuration settings for the handling of the stateful rule groups in a firewall policy. '
CustomActions:
type: array
items:
$ref: '#/components/schemas/CustomAction'
FirewallPolicy:
type: object
required:
- StatelessDefaultActions
- StatelessFragmentDefaultActions
properties:
StatelessRuleGroupReferences:
allOf:
- $ref: '#/components/schemas/StatelessRuleGroupReferences'
- description: 'References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules. '
StatelessDefaultActions:
allOf:
- $ref: '#/components/schemas/StatelessActions'
- description: '<p>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 <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>["aws:pass"]</code> or you could specify <code>["aws:pass", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>'
StatelessFragmentDefaultActions:
allOf:
- $ref: '#/components/schemas/StatelessActions'
- description: '<p>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 <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>["aws:pass"]</code> or you could specify <code>["aws:pass", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>'
StatelessCustomActions:
allOf:
- $ref: '#/components/schemas/CustomActions'
- description: The custom action definitions that are available for use in the firewall policy's <code>StatelessDefaultActions</code> 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: <p>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.</p> <p>Valid values of the stateful default action:</p> <ul> <li> <p>aws:drop_strict</p> </li> <li> <p>aws:drop_established</p> </li> <li> <p>aws:alert_strict</p> </li> <li> <p>aws:alert_established</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html">Strict evaluation order</a> in the <i>Network Firewall Developer Guide</i>. </p>
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: <p>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. </p> <p>This, along with <a
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-network-firewall/refs/heads/main/openapi/amazon-network-firewall-x-amz-target-networkfirewall-20201112-describefirewallpolicy-api-openapi.yml