AWS Network Firewall

{'FirewallStatus': {'SyncStates': {'Attachment': {'Status': {'ERROR',
                                                             'FAILED'}}}}}

Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.

The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

After you create a firewall, you can provide additional settings, like the logging configuration.

To update the settings for a firewall, you use the operations that apply to the settings themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.

To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.

See also: AWS API Documentation

Request Syntax

client.create_firewall(
    FirewallName='string',
    FirewallPolicyArn='string',
    VpcId='string',
    SubnetMappings=[
        {
            'SubnetId': 'string',
            'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
        },
    ],
    DeleteProtection=True|False,
    SubnetChangeProtection=True|False,
    FirewallPolicyChangeProtection=True|False,
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    EncryptionConfiguration={
        'KeyId': 'string',
        'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
    }
)

type FirewallName

string

param FirewallName

[REQUIRED]

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

type FirewallPolicyArn

string

param FirewallPolicyArn

[REQUIRED]

The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use for the firewall.

type VpcId

string

param VpcId

[REQUIRED]

The unique identifier of the VPC where Network Firewall should create the firewall.

You can't change this setting after you create the firewall.

type SubnetMappings

list

param SubnetMappings

[REQUIRED]

The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

• (dict) --

  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.

  • SubnetId (string) -- [REQUIRED]

    The unique identifier for the subnet.

  • IPAddressType (string) --

    The subnet's IP address type. You can't change the IP address type after you create the subnet.

type DeleteProtection

boolean

param DeleteProtection

A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

type SubnetChangeProtection

boolean

param SubnetChangeProtection

A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

type FirewallPolicyChangeProtection

boolean

param FirewallPolicyChangeProtection

A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

type Description

string

param Description

A description of the firewall.

type Tags

list

param Tags

The key:value pairs to associate with the resource.

• (dict) --

  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.

  • Key (string) -- [REQUIRED]

    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 (string) -- [REQUIRED]

    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.

type EncryptionConfiguration

dict

param EncryptionConfiguration

A complex type that contains settings for encryption of your firewall resources.

• KeyId (string) --

  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 (string) -- [REQUIRED]

  The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

rtype

dict

returns

Response Syntax

{
    'Firewall': {
        'FirewallName': 'string',
        'FirewallArn': 'string',
        'FirewallPolicyArn': 'string',
        'VpcId': 'string',
        'SubnetMappings': [
            {
                'SubnetId': 'string',
                'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
            },
        ],
        'DeleteProtection': True|False,
        'SubnetChangeProtection': True|False,
        'FirewallPolicyChangeProtection': True|False,
        'Description': 'string',
        'FirewallId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        }
    },
    'FirewallStatus': {
        'Status': 'PROVISIONING'|'DELETING'|'READY',
        'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
        'SyncStates': {
            'string': {
                'Attachment': {
                    'SubnetId': 'string',
                    'EndpointId': 'string',
                    'Status': 'CREATING'|'DELETING'|'SCALING'|'READY'|'FAILED'|'ERROR',
                    'StatusMessage': 'string'
                },
                'Config': {
                    'string': {
                        'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
                        'UpdateToken': 'string'
                    }
                }
            }
        },
        'CapacityUsageSummary': {
            'CIDRs': {
                'AvailableCIDRCount': 123,
                'UtilizedCIDRCount': 123,
                'IPSetReferences': {
                    'string': {
                        'ResolvedCIDRCount': 123
                    }
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • Firewall (dict) --

    The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

    • FirewallName (string) --

      The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    • FirewallArn (string) --

      The Amazon Resource Name (ARN) of the firewall.

    • FirewallPolicyArn (string) --

      The Amazon Resource Name (ARN) of the firewall policy.

      The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    • VpcId (string) --

      The unique identifier of the VPC where the firewall is in use.

    • SubnetMappings (list) --

      The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.

      • (dict) --

        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.

        • SubnetId (string) --

          The unique identifier for the subnet.

        • IPAddressType (string) --

          The subnet's IP address type. You can't change the IP address type after you create the subnet.

    • DeleteProtection (boolean) --

      A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

    • SubnetChangeProtection (boolean) --

      A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

    • FirewallPolicyChangeProtection (boolean) --

      A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

    • Description (string) --

      A description of the firewall.

    • FirewallId (string) --

      The unique identifier for the firewall.

    • Tags (list) --

      • (dict) --

        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.

        • Key (string) --

          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 (string) --

          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.

    • EncryptionConfiguration (dict) --

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

      • KeyId (string) --

        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 (string) --

        The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

  • FirewallStatus (dict) --

    Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

    • Status (string) --

      The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY .

    • ConfigurationSyncStateSummary (string) --

      The configuration sync state for the firewall. This summarizes the sync states reported in the Config settings for all of the Availability Zones where you have configured the firewall.

      When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This summary indicates whether the configuration changes have been applied everywhere.

      This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness.

    • SyncStates (dict) --

      The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the ConfigurationSyncStateSummary and Status , broken down by zone and configuration object.

      • (string) --

        • (dict) --

          The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.

          For each VPC subnet that you associate with a firewall, Network Firewall does the following:

          • Instantiates a firewall endpoint in the subnet, ready to take traffic.

          • Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.

          When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.

          • Attachment (dict) --

            The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.

            • SubnetId (string) --

              The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

            • EndpointId (string) --

              The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.

            • Status (string) --

              The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY , the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or DELETING .

            • StatusMessage (string) --

              If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide .

          • Config (dict) --

            The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.

            • (string) --

              • (dict) --

                Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.

                • SyncStatus (string) --

                  Indicates whether this object is in sync with the version indicated in the update token.

                • UpdateToken (string) --

                  The current version of the object that is either in sync or pending synchronization.

    • CapacityUsageSummary (dict) --

      Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.

      • CIDRs (dict) --

        Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.

        • AvailableCIDRCount (integer) --

          The number of CIDR blocks available for use by the IP set references in a firewall.

        • UtilizedCIDRCount (integer) --

          The number of CIDR blocks used by the IP set references in a firewall.

        • IPSetReferences (dict) --

          The list of the IP set references used by a firewall.

          • (string) --

            • (dict) --

              General information about the IP set.

              • ResolvedCIDRCount (integer) --

                Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount .

{'FirewallPolicy': {'PolicyVariables': {'RuleVariables': {'string': {'Definition': ['string']}}}}}

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.

See also: AWS API Documentation

Request Syntax

client.create_firewall_policy(
    FirewallPolicyName='string',
    FirewallPolicy={
        'StatelessRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123
            },
        ],
        'StatelessDefaultActions': [
            'string',
        ],
        'StatelessFragmentDefaultActions': [
            'string',
        ],
        'StatelessCustomActions': [
            {
                'ActionName': 'string',
                'ActionDefinition': {
                    'PublishMetricAction': {
                        'Dimensions': [
                            {
                                'Value': 'string'
                            },
                        ]
                    }
                }
            },
        ],
        'StatefulRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123,
                'Override': {
                    'Action': 'DROP_TO_ALERT'
                }
            },
        ],
        'StatefulDefaultActions': [
            'string',
        ],
        'StatefulEngineOptions': {
            'RuleOrder': 'DEFAULT_ACTION_ORDER'|'STRICT_ORDER',
            'StreamExceptionPolicy': 'DROP'|'CONTINUE'
        },
        'TLSInspectionConfigurationArn': 'string',
        'PolicyVariables': {
            'RuleVariables': {
                'string': {
                    'Definition': [
                        'string',
                    ]
                }
            }
        }
    },
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    DryRun=True|False,
    EncryptionConfiguration={
        'KeyId': 'string',
        'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
    }
)

type FirewallPolicyName

string

param FirewallPolicyName

[REQUIRED]

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

type FirewallPolicy

dict

param FirewallPolicy

[REQUIRED]

The rule groups and policy actions to use in the firewall policy.

• StatelessRuleGroupReferences (list) --

  References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

  • (dict) --

    Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

    • ResourceArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the stateless rule group.

    • Priority (integer) -- [REQUIRED]

      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.

• StatelessDefaultActions (list) -- [REQUIRED]

  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.

  • (string) --

• StatelessFragmentDefaultActions (list) -- [REQUIRED]

  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.

  • (string) --

• StatelessCustomActions (list) --

  The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.

  • (dict) --

    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.

    • ActionName (string) -- [REQUIRED]

      The descriptive name of the custom action. You can't change the name of a custom action after you create it.

    • ActionDefinition (dict) -- [REQUIRED]

      The custom action associated with the action name.

      • PublishMetricAction (dict) --

        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.

        • Dimensions (list) -- [REQUIRED]

          • (dict) --

            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.

            • Value (string) -- [REQUIRED]

              The value to use in the custom metric dimension.

• StatefulRuleGroupReferences (list) --

  References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.

  • (dict) --

    Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

    • ResourceArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the stateful rule group.

    • Priority (integer) --

      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 (dict) --

      The action that allows the policy owner to override the behavior of the rule group within a policy.

      • Action (string) --

        The action that changes the rule group from DROP to ALERT . This only applies to managed rule groups.

• StatefulDefaultActions (list) --

  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 .

  • (string) --

• StatefulEngineOptions (dict) --

  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.

  • RuleOrder (string) --

    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 (string) --

    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.

• TLSInspectionConfigurationArn (string) --

  The Amazon Resource Name (ARN) of the TLS inspection configuration.

• PolicyVariables (dict) --

  Contains variables that you can use to override default Suricata settings in your firewall policy.

  • RuleVariables (dict) --

    The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.

    • (string) --

      • (dict) --

        A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.

        • Definition (list) -- [REQUIRED]

          The list of IP addresses and address ranges, in CIDR notation.

          • (string) --

type Description

string

param Description

A description of the firewall policy.

type Tags

list

param Tags

The key:value pairs to associate with the resource.

• (dict) --

  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.

  • Key (string) -- [REQUIRED]

    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 (string) -- [REQUIRED]

    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.

type DryRun

boolean

param DryRun

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.

type EncryptionConfiguration

dict

param EncryptionConfiguration

A complex type that contains settings for encryption of your firewall policy resources.

• KeyId (string) --

  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 (string) -- [REQUIRED]

  The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

rtype

dict

returns

Response Syntax

{
    'UpdateToken': 'string',
    'FirewallPolicyResponse': {
        'FirewallPolicyName': 'string',
        'FirewallPolicyArn': 'string',
        'FirewallPolicyId': 'string',
        'Description': 'string',
        'FirewallPolicyStatus': 'ACTIVE'|'DELETING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConsumedStatelessRuleCapacity': 123,
        'ConsumedStatefulRuleCapacity': 123,
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • UpdateToken (string) --

    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.

  • FirewallPolicyResponse (dict) --

    The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

    • FirewallPolicyName (string) --

      The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

    • FirewallPolicyArn (string) --

      The Amazon Resource Name (ARN) of the firewall policy.

      Note

      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.

    • FirewallPolicyId (string) --

      The unique identifier for the firewall policy.

    • Description (string) --

      A description of the firewall policy.

    • FirewallPolicyStatus (string) --

      The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

    • Tags (list) --

      The key:value pairs to associate with the resource.

      • (dict) --

        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.

        • Key (string) --

          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 (string) --

          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.

    • ConsumedStatelessRuleCapacity (integer) --

      The number of capacity units currently consumed by the policy's stateless rules.

    • ConsumedStatefulRuleCapacity (integer) --

      The number of capacity units currently consumed by the policy's stateful rules.

    • NumberOfAssociations (integer) --

      The number of firewalls that are associated with this firewall policy.

    • EncryptionConfiguration (dict) --

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

      • KeyId (string) --

        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 (string) --

        The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

    • LastModifiedTime (datetime) --

      The last time that the firewall policy was changed.

{'FirewallStatus': {'SyncStates': {'Attachment': {'Status': {'ERROR',
                                                             'FAILED'}}}}}

Deletes the specified Firewall and its FirewallStatus. This operation requires the firewall's DeleteProtection flag to be FALSE . You can't revert this operation.

You can check whether a firewall is in use by reviewing the route tables for the Availability Zones where you have firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall. You define and update the route tables through Amazon VPC. As needed, update the route tables for the zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints, you can remove the firewall safely.

To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection, then delete the firewall by calling DeleteFirewall.

See also: AWS API Documentation

Request Syntax

client.delete_firewall(
    FirewallName='string',
    FirewallArn='string'
)

type FirewallName

string

param FirewallName

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.

type FirewallArn

string

param FirewallArn

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

rtype

dict

returns

Response Syntax

{
    'Firewall': {
        'FirewallName': 'string',
        'FirewallArn': 'string',
        'FirewallPolicyArn': 'string',
        'VpcId': 'string',
        'SubnetMappings': [
            {
                'SubnetId': 'string',
                'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
            },
        ],
        'DeleteProtection': True|False,
        'SubnetChangeProtection': True|False,
        'FirewallPolicyChangeProtection': True|False,
        'Description': 'string',
        'FirewallId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        }
    },
    'FirewallStatus': {
        'Status': 'PROVISIONING'|'DELETING'|'READY',
        'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
        'SyncStates': {
            'string': {
                'Attachment': {
                    'SubnetId': 'string',
                    'EndpointId': 'string',
                    'Status': 'CREATING'|'DELETING'|'SCALING'|'READY'|'FAILED'|'ERROR',
                    'StatusMessage': 'string'
                },
                'Config': {
                    'string': {
                        'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
                        'UpdateToken': 'string'
                    }
                }
            }
        },
        'CapacityUsageSummary': {
            'CIDRs': {
                'AvailableCIDRCount': 123,
                'UtilizedCIDRCount': 123,
                'IPSetReferences': {
                    'string': {
                        'ResolvedCIDRCount': 123
                    }
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • Firewall (dict) --

    The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.

    The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.

    • FirewallName (string) --

      The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    • FirewallArn (string) --

      The Amazon Resource Name (ARN) of the firewall.

    • FirewallPolicyArn (string) --

      The Amazon Resource Name (ARN) of the firewall policy.

      The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    • VpcId (string) --

      The unique identifier of the VPC where the firewall is in use.

    • SubnetMappings (list) --

      The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.

      • (dict) --

        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.

        • SubnetId (string) --

          The unique identifier for the subnet.

        • IPAddressType (string) --

          The subnet's IP address type. You can't change the IP address type after you create the subnet.

    • DeleteProtection (boolean) --

      A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

    • SubnetChangeProtection (boolean) --

      A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

    • FirewallPolicyChangeProtection (boolean) --

      A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

    • Description (string) --

      A description of the firewall.

    • FirewallId (string) --

      The unique identifier for the firewall.

    • Tags (list) --

      • (dict) --

        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.

        • Key (string) --

          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 (string) --

          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.

    • EncryptionConfiguration (dict) --

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

      • KeyId (string) --

        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 (string) --

        The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

  • FirewallStatus (dict) --

    Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

    • Status (string) --

      The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY .

    • ConfigurationSyncStateSummary (string) --

      The configuration sync state for the firewall. This summarizes the sync states reported in the Config settings for all of the Availability Zones where you have configured the firewall.

      When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This summary indicates whether the configuration changes have been applied everywhere.

      This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness.

    • SyncStates (dict) --

      The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the ConfigurationSyncStateSummary and Status , broken down by zone and configuration object.

      • (string) --

        • (dict) --

          The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.

          For each VPC subnet that you associate with a firewall, Network Firewall does the following:

          • Instantiates a firewall endpoint in the subnet, ready to take traffic.

          • Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.

          When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.

          • Attachment (dict) --

            The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.

            • SubnetId (string) --

              The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

            • EndpointId (string) --

              The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.

            • Status (string) --

              The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY , the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or DELETING .

            • StatusMessage (string) --

              If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide .

          • Config (dict) --

            The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.

            • (string) --

              • (dict) --

                Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.

                • SyncStatus (string) --

                  Indicates whether this object is in sync with the version indicated in the update token.

                • UpdateToken (string) --

                  The current version of the object that is either in sync or pending synchronization.

    • CapacityUsageSummary (dict) --

      Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.

      • CIDRs (dict) --

        Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.

        • AvailableCIDRCount (integer) --

          The number of CIDR blocks available for use by the IP set references in a firewall.

        • UtilizedCIDRCount (integer) --

          The number of CIDR blocks used by the IP set references in a firewall.

        • IPSetReferences (dict) --

          The list of the IP set references used by a firewall.

          • (string) --

            • (dict) --

              General information about the IP set.

              • ResolvedCIDRCount (integer) --

                Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount .

{'FirewallStatus': {'SyncStates': {'Attachment': {'Status': {'ERROR',
                                                             'FAILED'}}}}}

Returns the data objects for the specified firewall.

See also: AWS API Documentation

Request Syntax

client.describe_firewall(
    FirewallName='string',
    FirewallArn='string'
)

type FirewallName

string

param FirewallName

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.

type FirewallArn

string

param FirewallArn

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

rtype

dict

returns

Response Syntax

{
    'UpdateToken': 'string',
    'Firewall': {
        'FirewallName': 'string',
        'FirewallArn': 'string',
        'FirewallPolicyArn': 'string',
        'VpcId': 'string',
        'SubnetMappings': [
            {
                'SubnetId': 'string',
                'IPAddressType': 'DUALSTACK'|'IPV4'|'IPV6'
            },
        ],
        'DeleteProtection': True|False,
        'SubnetChangeProtection': True|False,
        'FirewallPolicyChangeProtection': True|False,
        'Description': 'string',
        'FirewallId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        }
    },
    'FirewallStatus': {
        'Status': 'PROVISIONING'|'DELETING'|'READY',
        'ConfigurationSyncStateSummary': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
        'SyncStates': {
            'string': {
                'Attachment': {
                    'SubnetId': 'string',
                    'EndpointId': 'string',
                    'Status': 'CREATING'|'DELETING'|'SCALING'|'READY'|'FAILED'|'ERROR',
                    'StatusMessage': 'string'
                },
                'Config': {
                    'string': {
                        'SyncStatus': 'PENDING'|'IN_SYNC'|'CAPACITY_CONSTRAINED',
                        'UpdateToken': 'string'
                    }
                }
            }
        },
        'CapacityUsageSummary': {
            'CIDRs': {
                'AvailableCIDRCount': 123,
                'UtilizedCIDRCount': 123,
                'IPSetReferences': {
                    'string': {
                        'ResolvedCIDRCount': 123
                    }
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • UpdateToken (string) --

    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.

  • Firewall (dict) --

    The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

    • FirewallName (string) --

      The descriptive name of the firewall. You can't change the name of a firewall after you create it.

    • FirewallArn (string) --

      The Amazon Resource Name (ARN) of the firewall.

    • FirewallPolicyArn (string) --

      The Amazon Resource Name (ARN) of the firewall policy.

      The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

    • VpcId (string) --

      The unique identifier of the VPC where the firewall is in use.

    • SubnetMappings (list) --

      The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.

      • (dict) --

        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.

        • SubnetId (string) --

          The unique identifier for the subnet.

        • IPAddressType (string) --

          The subnet's IP address type. You can't change the IP address type after you create the subnet.

    • DeleteProtection (boolean) --

      A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

    • SubnetChangeProtection (boolean) --

      A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

    • FirewallPolicyChangeProtection (boolean) --

      A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

    • Description (string) --

      A description of the firewall.

    • FirewallId (string) --

      The unique identifier for the firewall.

    • Tags (list) --

      • (dict) --

        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.

        • Key (string) --

          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 (string) --

          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.

    • EncryptionConfiguration (dict) --

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.

      • KeyId (string) --

        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 (string) --

        The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

  • FirewallStatus (dict) --

    Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

    • Status (string) --

      The readiness of the configured firewall to handle network traffic across all of the Availability Zones where you've configured it. This setting is READY only when the ConfigurationSyncStateSummary value is IN_SYNC and the Attachment Status values for all of the configured subnets are READY .

    • ConfigurationSyncStateSummary (string) --

      The configuration sync state for the firewall. This summarizes the sync states reported in the Config settings for all of the Availability Zones where you have configured the firewall.

      When you create a firewall or update its configuration, for example by adding a rule group to its firewall policy, Network Firewall distributes the configuration changes to all zones where the firewall is in use. This summary indicates whether the configuration changes have been applied everywhere.

      This status must be IN_SYNC for the firewall to be ready for use, but it doesn't indicate that the firewall is ready. The Status setting indicates firewall readiness.

    • SyncStates (dict) --

      The subnets that you've configured for use by the Network Firewall firewall. This contains one array element per Availability Zone where you've configured a subnet. These objects provide details of the information that is summarized in the ConfigurationSyncStateSummary and Status , broken down by zone and configuration object.

      • (string) --

        • (dict) --

          The status of the firewall endpoint and firewall policy configuration for a single VPC subnet.

          For each VPC subnet that you associate with a firewall, Network Firewall does the following:

          • Instantiates a firewall endpoint in the subnet, ready to take traffic.

          • Configures the endpoint with the current firewall policy settings, to provide the filtering behavior for the endpoint.

          When you update a firewall, for example to add a subnet association or change a rule group in the firewall policy, the affected sync states reflect out-of-sync or not ready status until the changes are complete.

          • Attachment (dict) --

            The attachment status of the firewall's association with a single VPC subnet. For each configured subnet, Network Firewall creates the attachment by instantiating the firewall endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.

            • SubnetId (string) --

              The unique identifier of the subnet that you've specified to be used for a firewall endpoint.

            • EndpointId (string) --

              The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.

            • Status (string) --

              The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this value is READY , the endpoint is available and configured properly to handle network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or DELETING .

            • StatusMessage (string) --

              If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide .

          • Config (dict) --

            The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.

            • (string) --

              • (dict) --

                Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.

                • SyncStatus (string) --

                  Indicates whether this object is in sync with the version indicated in the update token.

                • UpdateToken (string) --

                  The current version of the object that is either in sync or pending synchronization.

    • CapacityUsageSummary (dict) --

      Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.

      • CIDRs (dict) --

        Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.

        • AvailableCIDRCount (integer) --

          The number of CIDR blocks available for use by the IP set references in a firewall.

        • UtilizedCIDRCount (integer) --

          The number of CIDR blocks used by the IP set references in a firewall.

        • IPSetReferences (dict) --

          The list of the IP set references used by a firewall.

          • (string) --

            • (dict) --

              General information about the IP set.

              • ResolvedCIDRCount (integer) --

                Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount .

{'FirewallPolicy': {'PolicyVariables': {'RuleVariables': {'string': {'Definition': ['string']}}}}}

Returns the data objects for the specified firewall policy.

See also: AWS API Documentation

Request Syntax

client.describe_firewall_policy(
    FirewallPolicyName='string',
    FirewallPolicyArn='string'
)

type FirewallPolicyName

string

param FirewallPolicyName

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

type FirewallPolicyArn

string

param FirewallPolicyArn

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

rtype

dict

returns

Response Syntax

{
    'UpdateToken': 'string',
    'FirewallPolicyResponse': {
        'FirewallPolicyName': 'string',
        'FirewallPolicyArn': 'string',
        'FirewallPolicyId': 'string',
        'Description': 'string',
        'FirewallPolicyStatus': 'ACTIVE'|'DELETING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConsumedStatelessRuleCapacity': 123,
        'ConsumedStatefulRuleCapacity': 123,
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'LastModifiedTime': datetime(2015, 1, 1)
    },
    'FirewallPolicy': {
        'StatelessRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123
            },
        ],
        'StatelessDefaultActions': [
            'string',
        ],
        'StatelessFragmentDefaultActions': [
            'string',
        ],
        'StatelessCustomActions': [
            {
                'ActionName': 'string',
                'ActionDefinition': {
                    'PublishMetricAction': {
                        'Dimensions': [
                            {
                                'Value': 'string'
                            },
                        ]
                    }
                }
            },
        ],
        'StatefulRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123,
                'Override': {
                    'Action': 'DROP_TO_ALERT'
                }
            },
        ],
        'StatefulDefaultActions': [
            'string',
        ],
        'StatefulEngineOptions': {
            'RuleOrder': 'DEFAULT_ACTION_ORDER'|'STRICT_ORDER',
            'StreamExceptionPolicy': 'DROP'|'CONTINUE'
        },
        'TLSInspectionConfigurationArn': 'string',
        'PolicyVariables': {
            'RuleVariables': {
                'string': {
                    'Definition': [
                        'string',
                    ]
                }
            }
        }
    }
}

Response Structure

• (dict) --

  • UpdateToken (string) --

    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.

  • FirewallPolicyResponse (dict) --

    The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

    • FirewallPolicyName (string) --

      The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

    • FirewallPolicyArn (string) --

      The Amazon Resource Name (ARN) of the firewall policy.

      Note

      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.

    • FirewallPolicyId (string) --

      The unique identifier for the firewall policy.

    • Description (string) --

      A description of the firewall policy.

    • FirewallPolicyStatus (string) --

      The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

    • Tags (list) --

      The key:value pairs to associate with the resource.

      • (dict) --

        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.

        • Key (string) --

          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 (string) --

          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.

    • ConsumedStatelessRuleCapacity (integer) --

      The number of capacity units currently consumed by the policy's stateless rules.

    • ConsumedStatefulRuleCapacity (integer) --

      The number of capacity units currently consumed by the policy's stateful rules.

    • NumberOfAssociations (integer) --

      The number of firewalls that are associated with this firewall policy.

    • EncryptionConfiguration (dict) --

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

      • KeyId (string) --

        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 (string) --

        The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

    • LastModifiedTime (datetime) --

      The last time that the firewall policy was changed.

  • FirewallPolicy (dict) --

    The policy for the specified firewall policy.

    • StatelessRuleGroupReferences (list) --

      References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

      • (dict) --

        Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the stateless rule group.

        • Priority (integer) --

          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.

    • StatelessDefaultActions (list) --

      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.

      • (string) --

    • StatelessFragmentDefaultActions (list) --

      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.

      • (string) --

    • StatelessCustomActions (list) --

      The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.

      • (dict) --

        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.

        • ActionName (string) --

          The descriptive name of the custom action. You can't change the name of a custom action after you create it.

        • ActionDefinition (dict) --

          The custom action associated with the action name.

          • PublishMetricAction (dict) --

            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.

            • Dimensions (list) --

              • (dict) --

                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.

                • Value (string) --

                  The value to use in the custom metric dimension.

    • StatefulRuleGroupReferences (list) --

      References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.

      • (dict) --

        Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

        • ResourceArn (string) --

          The Amazon Resource Name (ARN) of the stateful rule group.

        • Priority (integer) --

          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 (dict) --

          The action that allows the policy owner to override the behavior of the rule group within a policy.

          • Action (string) --

            The action that changes the rule group from DROP to ALERT . This only applies to managed rule groups.

    • StatefulDefaultActions (list) --

      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 .

      • (string) --

    • StatefulEngineOptions (dict) --

      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.

      • RuleOrder (string) --

        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 (string) --

        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.

    • TLSInspectionConfigurationArn (string) --

      The Amazon Resource Name (ARN) of the TLS inspection configuration.

    • PolicyVariables (dict) --

      Contains variables that you can use to override default Suricata settings in your firewall policy.

      • RuleVariables (dict) --

        The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.

        • (string) --

          • (dict) --

            A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.

            • Definition (list) --

              The list of IP addresses and address ranges, in CIDR notation.

              • (string) --

{'FirewallPolicy': {'PolicyVariables': {'RuleVariables': {'string': {'Definition': ['string']}}}}}

Updates the properties of the specified firewall policy.

See also: AWS API Documentation

Request Syntax

client.update_firewall_policy(
    UpdateToken='string',
    FirewallPolicyArn='string',
    FirewallPolicyName='string',
    FirewallPolicy={
        'StatelessRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123
            },
        ],
        'StatelessDefaultActions': [
            'string',
        ],
        'StatelessFragmentDefaultActions': [
            'string',
        ],
        'StatelessCustomActions': [
            {
                'ActionName': 'string',
                'ActionDefinition': {
                    'PublishMetricAction': {
                        'Dimensions': [
                            {
                                'Value': 'string'
                            },
                        ]
                    }
                }
            },
        ],
        'StatefulRuleGroupReferences': [
            {
                'ResourceArn': 'string',
                'Priority': 123,
                'Override': {
                    'Action': 'DROP_TO_ALERT'
                }
            },
        ],
        'StatefulDefaultActions': [
            'string',
        ],
        'StatefulEngineOptions': {
            'RuleOrder': 'DEFAULT_ACTION_ORDER'|'STRICT_ORDER',
            'StreamExceptionPolicy': 'DROP'|'CONTINUE'
        },
        'TLSInspectionConfigurationArn': 'string',
        'PolicyVariables': {
            'RuleVariables': {
                'string': {
                    'Definition': [
                        'string',
                    ]
                }
            }
        }
    },
    Description='string',
    DryRun=True|False,
    EncryptionConfiguration={
        'KeyId': 'string',
        'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
    }
)

type UpdateToken

string

param UpdateToken

[REQUIRED]

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.

type FirewallPolicyArn

string

param FirewallPolicyArn

The Amazon Resource Name (ARN) of the firewall policy.

You must specify the ARN or the name, and you can specify both.

type FirewallPolicyName

string

param FirewallPolicyName

The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

You must specify the ARN or the name, and you can specify both.

type FirewallPolicy

dict

param FirewallPolicy

[REQUIRED]

The updated firewall policy to use for the firewall.

• StatelessRuleGroupReferences (list) --

  References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

  • (dict) --

    Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

    • ResourceArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the stateless rule group.

    • Priority (integer) -- [REQUIRED]

      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.

• StatelessDefaultActions (list) -- [REQUIRED]

  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.

  • (string) --

• StatelessFragmentDefaultActions (list) -- [REQUIRED]

  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.

  • (string) --

• StatelessCustomActions (list) --

  The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.

  • (dict) --

    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.

    • ActionName (string) -- [REQUIRED]

      The descriptive name of the custom action. You can't change the name of a custom action after you create it.

    • ActionDefinition (dict) -- [REQUIRED]

      The custom action associated with the action name.

      • PublishMetricAction (dict) --

        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.

        • Dimensions (list) -- [REQUIRED]

          • (dict) --

            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.

            • Value (string) -- [REQUIRED]

              The value to use in the custom metric dimension.

• StatefulRuleGroupReferences (list) --

  References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.

  • (dict) --

    Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

    • ResourceArn (string) -- [REQUIRED]

      The Amazon Resource Name (ARN) of the stateful rule group.

    • Priority (integer) --

      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 (dict) --

      The action that allows the policy owner to override the behavior of the rule group within a policy.

      • Action (string) --

        The action that changes the rule group from DROP to ALERT . This only applies to managed rule groups.

• StatefulDefaultActions (list) --

  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 .

  • (string) --

• StatefulEngineOptions (dict) --

  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.

  • RuleOrder (string) --

    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 (string) --

    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.

• TLSInspectionConfigurationArn (string) --

  The Amazon Resource Name (ARN) of the TLS inspection configuration.

• PolicyVariables (dict) --

  Contains variables that you can use to override default Suricata settings in your firewall policy.

  • RuleVariables (dict) --

    The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.

    • (string) --

      • (dict) --

        A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.

        • Definition (list) -- [REQUIRED]

          The list of IP addresses and address ranges, in CIDR notation.

          • (string) --

type Description

string

param Description

A description of the firewall policy.

type DryRun

boolean

param DryRun

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.

type EncryptionConfiguration

dict

param EncryptionConfiguration

A complex type that contains settings for encryption of your firewall policy resources.

• KeyId (string) --

  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 (string) -- [REQUIRED]

  The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

rtype

dict

returns

Response Syntax

{
    'UpdateToken': 'string',
    'FirewallPolicyResponse': {
        'FirewallPolicyName': 'string',
        'FirewallPolicyArn': 'string',
        'FirewallPolicyId': 'string',
        'Description': 'string',
        'FirewallPolicyStatus': 'ACTIVE'|'DELETING',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ConsumedStatelessRuleCapacity': 123,
        'ConsumedStatefulRuleCapacity': 123,
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'LastModifiedTime': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • UpdateToken (string) --

    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.

  • FirewallPolicyResponse (dict) --

    The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

    • FirewallPolicyName (string) --

      The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.

    • FirewallPolicyArn (string) --

      The Amazon Resource Name (ARN) of the firewall policy.

      Note

      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.

    • FirewallPolicyId (string) --

      The unique identifier for the firewall policy.

    • Description (string) --

      A description of the firewall policy.

    • FirewallPolicyStatus (string) --

      The current status of the firewall policy. You can retrieve this for a firewall policy by calling DescribeFirewallPolicy and providing the firewall policy's name or ARN.

    • Tags (list) --

      The key:value pairs to associate with the resource.

      • (dict) --

        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.

        • Key (string) --

          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 (string) --

          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.

    • ConsumedStatelessRuleCapacity (integer) --

      The number of capacity units currently consumed by the policy's stateless rules.

    • ConsumedStatefulRuleCapacity (integer) --

      The number of capacity units currently consumed by the policy's stateful rules.

    • NumberOfAssociations (integer) --

      The number of firewalls that are associated with this firewall policy.

    • EncryptionConfiguration (dict) --

      A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.

      • KeyId (string) --

        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 (string) --

        The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.

    • LastModifiedTime (datetime) --

      The last time that the firewall policy was changed.