tls_inspection_configurations

Creates, updates, deletes or gets a tls_inspection_configuration resource or lists tls_inspection_configurations in a region

Overview

Name	tls_inspection_configurations
Type	Resource
Description	Resource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
Id	awscc.networkfirewall.tls_inspection_configurations

Fields

get (all properties)

Name	Datatype	Description
tls_inspection_configuration_name	string
tls_inspection_configuration_arn	string	A resource ARN.
▶tls_inspection_configuration	object	Resource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
tls_inspection_configuration_id	string
description	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
tls_inspection_configuration_arn	string	A resource ARN.
▶tls_inspection_configuration	object	Resource type definition for AWS::NetworkFirewall::TLSInspectionConfiguration
region	string	AWS region.

For more information, see AWS::NetworkFirewall::TLSInspectionConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	tls_inspection_configurations	INSERT	TLSInspectionConfigurationName, TLSInspectionConfiguration, region
delete_resource	tls_inspection_configurations	DELETE	Identifier, region
update_resource	tls_inspection_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	tls_inspection_configurations_list_only	SELECT	region
get_resource	tls_inspection_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual tls_inspection_configuration.

SELECT
  region,
  tls_inspection_configuration_name,
  tls_inspection_configuration_arn,
  tls_inspection_configuration,
  tls_inspection_configuration_id,
  description,
  tags
FROM awscc.networkfirewall.tls_inspection_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ tls_inspection_configuration_arn }}';

list (identifiers only)

Lists all tls_inspection_configurations in a region.

SELECT
  region,
  tls_inspection_configuration_arn
FROM awscc.networkfirewall.tls_inspection_configurations_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new tls_inspection_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.networkfirewall.tls_inspection_configurations (
  TLSInspectionConfigurationName,
  TLSInspectionConfiguration,
  region
)
SELECT
  '{{ tls_inspection_configuration_name }}',
  '{{ tls_inspection_configuration }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.networkfirewall.tls_inspection_configurations (
  TLSInspectionConfigurationName,
  TLSInspectionConfiguration,
  Description,
  Tags,
  region
)
SELECT
  '{{ tls_inspection_configuration_name }}',
  '{{ tls_inspection_configuration }}',
  '{{ description }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: tls_inspection_configuration
    props:
      - name: tls_inspection_configuration_name
        value: '{{ tls_inspection_configuration_name }}'
      - name: tls_inspection_configuration
        value:
          tls_inspection_configuration_name: '{{ tls_inspection_configuration_name }}'
          tls_inspection_configuration: null
          description: '{{ description }}'
          tags:
            - key: '{{ key }}'
              value: '{{ value }}'
      - name: description
        value: '{{ description }}'
      - name: tags
        value:
          - null

UPDATE example

Use the following StackQL query and manifest file to update a tls_inspection_configuration resource, using stack-deploy.

/*+ update */
UPDATE awscc.networkfirewall.tls_inspection_configurations
SET PatchDocument = string('{{ {
    "TLSInspectionConfiguration": tls_inspection_configuration,
    "Description": description,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ tls_inspection_configuration_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.networkfirewall.tls_inspection_configurations
WHERE
  Identifier = '{{ tls_inspection_configuration_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the tls_inspection_configurations resource, the following permissions are required:

Create

iam:CreateServiceLinkedRole,
network-firewall:CreateTLSInspectionConfiguration,
network-firewall:DescribeTLSInspectionConfiguration,
network-firewall:TagResource

Read

network-firewall:DescribeTLSInspectionConfiguration,
network-firewall:ListTagsForResources

Update

network-firewall:UpdateTLSInspectionConfiguration,
network-firewall:DescribeTLSInspectionConfiguration,
network-firewall:TagResource,
network-firewall:UntagResource

Delete

network-firewall:DeleteTLSInspectionConfiguration,
network-firewall:DescribeTLSInspectionConfiguration,
network-firewall:UntagResource

List

network-firewall:ListTLSInspectionConfigurations