AWS API Changes

2023/03/30 - AWS Network Firewall - 5 new 3 updated api methods

Changes AWS Network Firewall added TLS inspection configurations to allow TLS traffic inspection.

UpdateTLSInspectionConfiguration (new)

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by reference in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.

To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.

See also: AWS API Documentation

Request Syntax

client.update_tls_inspection_configuration(
    TLSInspectionConfigurationArn='string',
    TLSInspectionConfigurationName='string',
    TLSInspectionConfiguration={
        'ServerCertificateConfigurations': [
            {
                'ServerCertificates': [
                    {
                        'ResourceArn': 'string'
                    },
                ],
                'Scopes': [
                    {
                        'Sources': [
                            {
                                'AddressDefinition': 'string'
                            },
                        ],
                        'Destinations': [
                            {
                                'AddressDefinition': 'string'
                            },
                        ],
                        'SourcePorts': [
                            {
                                'FromPort': 123,
                                'ToPort': 123
                            },
                        ],
                        'DestinationPorts': [
                            {
                                'FromPort': 123,
                                'ToPort': 123
                            },
                        ],
                        'Protocols': [
                            123,
                        ]
                    },
                ]
            },
        ]
    },
    Description='string',
    EncryptionConfiguration={
        'KeyId': 'string',
        'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
    },
    UpdateToken='string'
)

type TLSInspectionConfigurationArn

string

param TLSInspectionConfigurationArn

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

type TLSInspectionConfigurationName

string

param TLSInspectionConfigurationName

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

type TLSInspectionConfiguration

dict

param TLSInspectionConfiguration

[REQUIRED]

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide .

ServerCertificateConfigurations (list) --

Lists the server certificate configurations that are associated with the TLS configuration.
- (dict) --
  
  Configures the associated Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificates and scope settings Network Firewall uses to decrypt traffic in a TLSInspectionConfiguration. For information about working with SSL/TLS certificates for TLS inspection, see Requirements for using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide .
  
  Note
  
  If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.
  - ServerCertificates (list) --
    
    The list of a server certificate configuration's Certificate Manager SSL/TLS certificates.
    - (dict) --
      
      Any Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration used in a TLSInspectionConfiguration. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate or Importing certificates in the Certificate Manager User Guide .
      - ResourceArn (string) --
        
        The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate.
  - Scopes (list) --
    
    A list of a server certificate configuration's scopes.
    - (dict) --
      
      Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.
      - Sources (list) --
        
        The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
        
        (dict) --
        
        A single IP address specification. This is used in the MatchAttributes source and destination specifications.
        
        AddressDefinition (string) -- [REQUIRED]
        
        Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
        
        Examples:
        
        To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32 .
        
        To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .
        
        To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
        
        To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 .
        
        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
      - Destinations (list) --
        
        The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
        
        (dict) --
        
        A single IP address specification. This is used in the MatchAttributes source and destination specifications.
        
        AddressDefinition (string) -- [REQUIRED]
        
        Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
        
        Examples:
        
        To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32 .
        
        To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .
        
        To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
        
        To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 .
        
        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
      - SourcePorts (list) --
        
        The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
        
        You can specify individual ports, for example 1994 , and you can specify port ranges, such as 1990:1994 .
        
        (dict) --
        
        A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts , and DestinationPorts settings.
        
        FromPort (integer) -- [REQUIRED]
        
        The lower limit of the port range. This must be less than or equal to the ToPort specification.
        
        ToPort (integer) -- [REQUIRED]
        
        The upper limit of the port range. This must be greater than or equal to the FromPort specification.
      - DestinationPorts (list) --
        
        The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
        
        You can specify individual ports, for example 1994 , and you can specify port ranges, such as 1990:1994 .
        
        (dict) --
        
        A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts , and DestinationPorts settings.
        
        FromPort (integer) -- [REQUIRED]
        
        The lower limit of the port range. This must be less than or equal to the ToPort specification.
        
        ToPort (integer) -- [REQUIRED]
        
        The upper limit of the port range. This must be greater than or equal to the FromPort specification.
      - Protocols (list) --
        
        The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
        
        (integer) --

type Description

string

param Description

A description of the TLS inspection configuration.

type EncryptionConfiguration

dict

param EncryptionConfiguration

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

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.

type UpdateToken

string

param UpdateToken

[REQUIRED]

A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException . If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

rtype

dict

returns

Response Syntax

{
    'UpdateToken': 'string',
    'TLSInspectionConfigurationResponse': {
        'TLSInspectionConfigurationArn': 'string',
        'TLSInspectionConfigurationName': 'string',
        'TLSInspectionConfigurationId': 'string',
        'TLSInspectionConfigurationStatus': 'ACTIVE'|'DELETING',
        'Description': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LastModifiedTime': datetime(2015, 1, 1),
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'Certificates': [
            {
                'CertificateArn': 'string',
                'CertificateSerial': 'string',
                'Status': 'string',
                'StatusMessage': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- UpdateToken (string) --
  
  A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
  
  To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException . If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
- TLSInspectionConfigurationResponse (dict) --
  
  The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
  - TLSInspectionConfigurationArn (string) --
    
    The Amazon Resource Name (ARN) of the TLS inspection configuration.
  - TLSInspectionConfigurationName (string) --
    
    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
  - TLSInspectionConfigurationId (string) --
    
    A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
  - TLSInspectionConfigurationStatus (string) --
    
    Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
  - Description (string) --
    
    A description of the TLS inspection configuration.
  - 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.
  - LastModifiedTime (datetime) --
    
    The last time that the TLS inspection configuration was changed.
  - NumberOfAssociations (integer) --
    
    The number of firewall policies that use this TLS inspection configuration.
  - EncryptionConfiguration (dict) --
    
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
    - 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.
  - Certificates (list) --
    
    A list of the certificates associated with the TLS inspection configuration.
    - (dict) --
      
      Contains metadata about an Certificate Manager certificate.
      - CertificateArn (string) --
        
        The Amazon Resource Name (ARN) of the certificate.
      - CertificateSerial (string) --
        
        The serial number of the certificate.
      - Status (string) --
        
        The status of the certificate.
      - StatusMessage (string) --
        
        Contains details about the certificate status, including information about certificate errors.

DescribeTLSInspectionConfiguration (new)

Link ¶

Returns the data objects for the specified TLS inspection configuration.

See also: AWS API Documentation

Request Syntax

client.describe_tls_inspection_configuration(
    TLSInspectionConfigurationArn='string',
    TLSInspectionConfigurationName='string'
)

type TLSInspectionConfigurationArn

string

param TLSInspectionConfigurationArn

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

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

type TLSInspectionConfigurationName

string

param TLSInspectionConfigurationName

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

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

rtype

dict

returns

Response Syntax

{
    'UpdateToken': 'string',
    'TLSInspectionConfiguration': {
        'ServerCertificateConfigurations': [
            {
                'ServerCertificates': [
                    {
                        'ResourceArn': 'string'
                    },
                ],
                'Scopes': [
                    {
                        'Sources': [
                            {
                                'AddressDefinition': 'string'
                            },
                        ],
                        'Destinations': [
                            {
                                'AddressDefinition': 'string'
                            },
                        ],
                        'SourcePorts': [
                            {
                                'FromPort': 123,
                                'ToPort': 123
                            },
                        ],
                        'DestinationPorts': [
                            {
                                'FromPort': 123,
                                'ToPort': 123
                            },
                        ],
                        'Protocols': [
                            123,
                        ]
                    },
                ]
            },
        ]
    },
    'TLSInspectionConfigurationResponse': {
        'TLSInspectionConfigurationArn': 'string',
        'TLSInspectionConfigurationName': 'string',
        'TLSInspectionConfigurationId': 'string',
        'TLSInspectionConfigurationStatus': 'ACTIVE'|'DELETING',
        'Description': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LastModifiedTime': datetime(2015, 1, 1),
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'Certificates': [
            {
                'CertificateArn': 'string',
                'CertificateSerial': 'string',
                'Status': 'string',
                'StatusMessage': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- UpdateToken (string) --
  
  A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
  
  To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException . If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
- TLSInspectionConfiguration (dict) --
  
  The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
  
  Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
  
  To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide .
  - ServerCertificateConfigurations (list) --
    
    Lists the server certificate configurations that are associated with the TLS configuration.
    - (dict) --
      
      Configures the associated Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificates and scope settings Network Firewall uses to decrypt traffic in a TLSInspectionConfiguration. For information about working with SSL/TLS certificates for TLS inspection, see Requirements for using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide .
      
      Note
      
      If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.
      - ServerCertificates (list) --
        
        The list of a server certificate configuration's Certificate Manager SSL/TLS certificates.
        
        (dict) --
        
        Any Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration used in a TLSInspectionConfiguration. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate or Importing certificates in the Certificate Manager User Guide .
        
        ResourceArn (string) --
        
        The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate.
      - Scopes (list) --
        
        A list of a server certificate configuration's scopes.
        
        (dict) --
        
        Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.
        
        Sources (list) --
        
        The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
        
        (dict) --
        
        A single IP address specification. This is used in the MatchAttributes source and destination specifications.
        
        AddressDefinition (string) --
        
        Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
        
        Examples:
        
        To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32 .
        
        To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .
        
        To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
        
        To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 .
        
        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
        
        Destinations (list) --
        
        The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
        
        (dict) --
        
        A single IP address specification. This is used in the MatchAttributes source and destination specifications.
        
        AddressDefinition (string) --
        
        Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
        
        Examples:
        
        To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32 .
        
        To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .
        
        To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
        
        To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 .
        
        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
        
        SourcePorts (list) --
        
        The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
        
        You can specify individual ports, for example 1994 , and you can specify port ranges, such as 1990:1994 .
        
        (dict) --
        
        A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts , and DestinationPorts settings.
        
        FromPort (integer) --
        
        The lower limit of the port range. This must be less than or equal to the ToPort specification.
        
        ToPort (integer) --
        
        The upper limit of the port range. This must be greater than or equal to the FromPort specification.
        
        DestinationPorts (list) --
        
        The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
        
        You can specify individual ports, for example 1994 , and you can specify port ranges, such as 1990:1994 .
        
        (dict) --
        
        A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts , and DestinationPorts settings.
        
        FromPort (integer) --
        
        The lower limit of the port range. This must be less than or equal to the ToPort specification.
        
        ToPort (integer) --
        
        The upper limit of the port range. This must be greater than or equal to the FromPort specification.
        
        Protocols (list) --
        
        The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
        
        (integer) --
- TLSInspectionConfigurationResponse (dict) --
  
  The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
  - TLSInspectionConfigurationArn (string) --
    
    The Amazon Resource Name (ARN) of the TLS inspection configuration.
  - TLSInspectionConfigurationName (string) --
    
    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
  - TLSInspectionConfigurationId (string) --
    
    A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
  - TLSInspectionConfigurationStatus (string) --
    
    Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
  - Description (string) --
    
    A description of the TLS inspection configuration.
  - 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.
  - LastModifiedTime (datetime) --
    
    The last time that the TLS inspection configuration was changed.
  - NumberOfAssociations (integer) --
    
    The number of firewall policies that use this TLS inspection configuration.
  - EncryptionConfiguration (dict) --
    
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
    - 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.
  - Certificates (list) --
    
    A list of the certificates associated with the TLS inspection configuration.
    - (dict) --
      
      Contains metadata about an Certificate Manager certificate.
      - CertificateArn (string) --
        
        The Amazon Resource Name (ARN) of the certificate.
      - CertificateSerial (string) --
        
        The serial number of the certificate.
      - Status (string) --
        
        The status of the certificate.
      - StatusMessage (string) --
        
        Contains details about the certificate status, including information about certificate errors.

DeleteTLSInspectionConfiguration (new)

Link ¶

Deletes the specified TLSInspectionConfiguration.

See also: AWS API Documentation

Request Syntax

client.delete_tls_inspection_configuration(
    TLSInspectionConfigurationArn='string',
    TLSInspectionConfigurationName='string'
)

type TLSInspectionConfigurationArn

string

param TLSInspectionConfigurationArn

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

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

type TLSInspectionConfigurationName

string

param TLSInspectionConfigurationName

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

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

rtype

dict

returns

Response Syntax

{
    'TLSInspectionConfigurationResponse': {
        'TLSInspectionConfigurationArn': 'string',
        'TLSInspectionConfigurationName': 'string',
        'TLSInspectionConfigurationId': 'string',
        'TLSInspectionConfigurationStatus': 'ACTIVE'|'DELETING',
        'Description': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LastModifiedTime': datetime(2015, 1, 1),
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'Certificates': [
            {
                'CertificateArn': 'string',
                'CertificateSerial': 'string',
                'Status': 'string',
                'StatusMessage': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- TLSInspectionConfigurationResponse (dict) --
  
  The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
  - TLSInspectionConfigurationArn (string) --
    
    The Amazon Resource Name (ARN) of the TLS inspection configuration.
  - TLSInspectionConfigurationName (string) --
    
    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
  - TLSInspectionConfigurationId (string) --
    
    A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
  - TLSInspectionConfigurationStatus (string) --
    
    Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
  - Description (string) --
    
    A description of the TLS inspection configuration.
  - 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.
  - LastModifiedTime (datetime) --
    
    The last time that the TLS inspection configuration was changed.
  - NumberOfAssociations (integer) --
    
    The number of firewall policies that use this TLS inspection configuration.
  - EncryptionConfiguration (dict) --
    
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
    - 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.
  - Certificates (list) --
    
    A list of the certificates associated with the TLS inspection configuration.
    - (dict) --
      
      Contains metadata about an Certificate Manager certificate.
      - CertificateArn (string) --
        
        The Amazon Resource Name (ARN) of the certificate.
      - CertificateSerial (string) --
        
        The serial number of the certificate.
      - Status (string) --
        
        The status of the certificate.
      - StatusMessage (string) --
        
        Contains details about the certificate status, including information about certificate errors.

ListTLSInspectionConfigurations (new)

Link ¶

Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.

See also: AWS API Documentation

Request Syntax

client.list_tls_inspection_configurations(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

type MaxResults

integer

param MaxResults

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'TLSInspectionConfigurations': [
        {
            'Name': 'string',
            'Arn': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
- TLSInspectionConfigurations (list) --
  
  The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.
  - (dict) --
    
    High-level information about a TLS inspection configuration, returned by ListTLSInspectionConfigurations . You can use the information provided in the metadata to retrieve and manage a TLS configuration.
    - Name (string) --
      
      The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the TLS inspection configuration.

CreateTLSInspectionConfiguration (new)

Link ¶

Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains the Certificate Manager certificate references that Network Firewall uses to decrypt and re-encrypt inbound traffic.

After you create a TLS inspection configuration, you associate it with a firewall policy.

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

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

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

For more information about TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_tls_inspection_configuration(
    TLSInspectionConfigurationName='string',
    TLSInspectionConfiguration={
        'ServerCertificateConfigurations': [
            {
                'ServerCertificates': [
                    {
                        'ResourceArn': 'string'
                    },
                ],
                'Scopes': [
                    {
                        'Sources': [
                            {
                                'AddressDefinition': 'string'
                            },
                        ],
                        'Destinations': [
                            {
                                'AddressDefinition': 'string'
                            },
                        ],
                        'SourcePorts': [
                            {
                                'FromPort': 123,
                                'ToPort': 123
                            },
                        ],
                        'DestinationPorts': [
                            {
                                'FromPort': 123,
                                'ToPort': 123
                            },
                        ],
                        'Protocols': [
                            123,
                        ]
                    },
                ]
            },
        ]
    },
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    EncryptionConfiguration={
        'KeyId': 'string',
        'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
    }
)

type TLSInspectionConfigurationName

string

param TLSInspectionConfigurationName

[REQUIRED]

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

type TLSInspectionConfiguration

dict

param TLSInspectionConfiguration

[REQUIRED]

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

ServerCertificateConfigurations (list) --

Lists the server certificate configurations that are associated with the TLS configuration.
- (dict) --
  
  Configures the associated Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificates and scope settings Network Firewall uses to decrypt traffic in a TLSInspectionConfiguration. For information about working with SSL/TLS certificates for TLS inspection, see Requirements for using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide .
  
  Note
  
  If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.
  - ServerCertificates (list) --
    
    The list of a server certificate configuration's Certificate Manager SSL/TLS certificates.
    - (dict) --
      
      Any Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration used in a TLSInspectionConfiguration. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate or Importing certificates in the Certificate Manager User Guide .
      - ResourceArn (string) --
        
        The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate.
  - Scopes (list) --
    
    A list of a server certificate configuration's scopes.
    - (dict) --
      
      Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.
      - Sources (list) --
        
        The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.
        
        (dict) --
        
        A single IP address specification. This is used in the MatchAttributes source and destination specifications.
        
        AddressDefinition (string) -- [REQUIRED]
        
        Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
        
        Examples:
        
        To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32 .
        
        To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .
        
        To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
        
        To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 .
        
        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
      - Destinations (list) --
        
        The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
        
        (dict) --
        
        A single IP address specification. This is used in the MatchAttributes source and destination specifications.
        
        AddressDefinition (string) -- [REQUIRED]
        
        Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
        
        Examples:
        
        To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32 .
        
        To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24 .
        
        To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128 .
        
        To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64 .
        
        For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
      - SourcePorts (list) --
        
        The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
        
        You can specify individual ports, for example 1994 , and you can specify port ranges, such as 1990:1994 .
        
        (dict) --
        
        A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts , and DestinationPorts settings.
        
        FromPort (integer) -- [REQUIRED]
        
        The lower limit of the port range. This must be less than or equal to the ToPort specification.
        
        ToPort (integer) -- [REQUIRED]
        
        The upper limit of the port range. This must be greater than or equal to the FromPort specification.
      - DestinationPorts (list) --
        
        The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
        
        You can specify individual ports, for example 1994 , and you can specify port ranges, such as 1990:1994 .
        
        (dict) --
        
        A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts , and DestinationPorts settings.
        
        FromPort (integer) -- [REQUIRED]
        
        The lower limit of the port range. This must be less than or equal to the ToPort specification.
        
        ToPort (integer) -- [REQUIRED]
        
        The upper limit of the port range. This must be greater than or equal to the FromPort specification.
      - Protocols (list) --
        
        The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
        
        (integer) --

type Description

string

param Description

A description of the TLS inspection configuration.

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 optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide .

KeyId (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',
    'TLSInspectionConfigurationResponse': {
        'TLSInspectionConfigurationArn': 'string',
        'TLSInspectionConfigurationName': 'string',
        'TLSInspectionConfigurationId': 'string',
        'TLSInspectionConfigurationStatus': 'ACTIVE'|'DELETING',
        'Description': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'LastModifiedTime': datetime(2015, 1, 1),
        'NumberOfAssociations': 123,
        'EncryptionConfiguration': {
            'KeyId': 'string',
            'Type': 'CUSTOMER_KMS'|'AWS_OWNED_KMS_KEY'
        },
        'Certificates': [
            {
                'CertificateArn': 'string',
                'CertificateSerial': 'string',
                'Status': 'string',
                'StatusMessage': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- UpdateToken (string) --
  
  A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
  
  To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException . If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
- TLSInspectionConfigurationResponse (dict) --
  
  The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
  - TLSInspectionConfigurationArn (string) --
    
    The Amazon Resource Name (ARN) of the TLS inspection configuration.
  - TLSInspectionConfigurationName (string) --
    
    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
  - TLSInspectionConfigurationId (string) --
    
    A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
  - TLSInspectionConfigurationStatus (string) --
    
    Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
  - Description (string) --
    
    A description of the TLS inspection configuration.
  - 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.
  - LastModifiedTime (datetime) --
    
    The last time that the TLS inspection configuration was changed.
  - NumberOfAssociations (integer) --
    
    The number of firewall policies that use this TLS inspection configuration.
  - EncryptionConfiguration (dict) --
    
    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
    - 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.
  - Certificates (list) --
    
    A list of the certificates associated with the TLS inspection configuration.
    - (dict) --
      
      Contains metadata about an Certificate Manager certificate.
      - CertificateArn (string) --
        
        The Amazon Resource Name (ARN) of the certificate.
      - CertificateSerial (string) --
        
        The serial number of the certificate.
      - Status (string) --
        
        The status of the certificate.
      - StatusMessage (string) --
        
        Contains details about the certificate status, including information about certificate errors.

CreateFirewallPolicy (updated)

Link ¶
Changes (request)

{'FirewallPolicy': {'TLSInspectionConfigurationArn': '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'
    },
    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.

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.

DescribeFirewallPolicy (updated)

Link ¶
Changes (response)

{'FirewallPolicy': {'TLSInspectionConfigurationArn': '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'
    }
}

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.

UpdateFirewallPolicy (updated)

Link ¶
Changes (request)

{'FirewallPolicy': {'TLSInspectionConfigurationArn': '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'
    },
    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.

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 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.