tls_inspection_configurations

Creates, updates, deletes, gets or lists a tls_inspection_configurations resource.

Overview

Name	tls_inspection_configurations
Type	Resource
Id	aws.network_firewall.tls_inspection_configurations

Fields

The following fields are returned by SELECT queries:

describe_tls_inspection_configuration

Name	Datatype	Description
tls_inspection_configuration	object	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 new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. 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 Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
tls_inspection_configuration_response	object	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.
update_token	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. (pattern: <code>^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$</code>)

list_tls_inspection_configurations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the TLS inspection configuration. (pattern: <code>^arn:aws.*</code>)
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. (pattern: <code>^[a-zA-Z0-9-]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_tls_inspection_configuration	select	region		Returns the data objects for the specified TLS inspection configuration.
list_tls_inspection_configurations	select	region		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.
create_tls_inspection_configuration	insert	region, TLSInspectionConfigurationName, TLSInspectionConfiguration		Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall. 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 Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
update_tls_inspection_configuration	update	region, TLSInspectionConfiguration, UpdateToken		Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it 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.
delete_tls_inspection_configuration	delete	region		Deletes the specified TLSInspectionConfiguration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_tls_inspection_configuration

Returns the data objects for the specified TLS inspection configuration.

SELECT
tls_inspection_configuration,
tls_inspection_configuration_response,
update_token
FROM aws.network_firewall.tls_inspection_configurations
WHERE region = '{{ region }}' -- required
;

list_tls_inspection_configurations

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.

SELECT
arn,
name
FROM aws.network_firewall.tls_inspection_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_tls_inspection_configuration

Creates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using ACM, create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall. 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 Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

INSERT INTO aws.network_firewall.tls_inspection_configurations (
TLSInspectionConfigurationName,
TLSInspectionConfiguration,
Description,
Tags,
EncryptionConfiguration,
region
)
SELECT 
'{{ TLSInspectionConfigurationName }}' /* required */,
'{{ TLSInspectionConfiguration }}' /* required */,
'{{ Description }}',
'{{ Tags }}',
'{{ EncryptionConfiguration }}',
'{{ region }}'
RETURNING
tls_inspection_configuration_response,
update_token
;

Manifest

# Description fields are for documentation purposes
- name: tls_inspection_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the tls_inspection_configurations resource.
  - name: TLSInspectionConfigurationName
    value: "{{ TLSInspectionConfigurationName }}"
    description: |
      The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
  - name: TLSInspectionConfiguration
    description: |
      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 new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. 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 Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.
    value:
      ServerCertificateConfigurations:
        - ServerCertificates: "{{ ServerCertificates }}"
          Scopes: "{{ Scopes }}"
          CertificateAuthorityArn: "{{ CertificateAuthorityArn }}"
          CheckCertificateRevocationStatus:
            RevokedStatusAction: "{{ RevokedStatusAction }}"
            UnknownStatusAction: "{{ UnknownStatusAction }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      A description of the TLS inspection configuration.
  - name: Tags
    description: |
      The key:value pairs to associate with the resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: EncryptionConfiguration
    description: |
      A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
    value:
      KeyId: "{{ KeyId }}"
      Type: "{{ Type }}"

UPDATE examples

update_tls_inspection_configuration

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it 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.

UPDATE aws.network_firewall.tls_inspection_configurations
SET 
TLSInspectionConfigurationArn = '{{ TLSInspectionConfigurationArn }}',
TLSInspectionConfigurationName = '{{ TLSInspectionConfigurationName }}',
TLSInspectionConfiguration = '{{ TLSInspectionConfiguration }}',
Description = '{{ Description }}',
EncryptionConfiguration = '{{ EncryptionConfiguration }}',
UpdateToken = '{{ UpdateToken }}'
WHERE 
region = '{{ region }}' --required
AND TLSInspectionConfiguration = '{{ TLSInspectionConfiguration }}' --required
AND UpdateToken = '{{ UpdateToken }}' --required
RETURNING
tls_inspection_configuration_response,
update_token;

DELETE examples

delete_tls_inspection_configuration

Deletes the specified TLSInspectionConfiguration.

DELETE FROM aws.network_firewall.tls_inspection_configurations
WHERE region = '{{ region }}' --required
;