CfnTLSInspectionConfiguration

class aws_cdk.aws_networkfirewall.CfnTLSInspectionConfiguration(scope, id, *, tls_inspection_configuration, tls_inspection_configuration_name, description=None, tags=None)

Bases: CfnResource

The object that defines a TLS inspection configuration.

AWS 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 AWS Network Firewall Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html
CloudformationResource:: AWS::NetworkFirewall::TLSInspectionConfiguration
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

cfn_tLSInspection_configuration = networkfirewall.CfnTLSInspectionConfiguration(self, "MyCfnTLSInspectionConfiguration",
    tls_inspection_configuration=networkfirewall.CfnTLSInspectionConfiguration.TLSInspectionConfigurationProperty(
        server_certificate_configurations=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateConfigurationProperty(
            certificate_authority_arn="certificateAuthorityArn",
            check_certificate_revocation_status=networkfirewall.CfnTLSInspectionConfiguration.CheckCertificateRevocationStatusProperty(
                revoked_status_action="revokedStatusAction",
                unknown_status_action="unknownStatusAction"
            ),
            scopes=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateScopeProperty(
                destination_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
                    from_port=123,
                    to_port=123
                )],
                destinations=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
                    address_definition="addressDefinition"
                )],
                protocols=[123],
                source_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
                    from_port=123,
                    to_port=123
                )],
                sources=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
                    address_definition="addressDefinition"
                )]
            )],
            server_certificates=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateProperty(
                resource_arn="resourceArn"
            )]
        )]
    ),
    tls_inspection_configuration_name="tlsInspectionConfigurationName",

    # the properties below are optional
    description="description",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
tls_inspection_configuration (Union[IResolvable, TLSInspectionConfigurationProperty, Dict[str, Any]]) –
The object that defines a TLS inspection configuration. AWS Network Firewall uses TLS inspection configurations to decrypt your firewall’s inbound and outbound SSL/TLS traffic. After decryption, AWS 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 AWS Certificate Manager , create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the AWS Network Firewall Developer Guide .
tls_inspection_configuration_name (str) – The descriptive name of the TLS inspection configuration. You can’t change the name of a TLS inspection configuration after you create it.
description (Optional[str]) – A description of the TLS inspection configuration.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The key:value pairs to associate with the resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::NetworkFirewall::TLSInspectionConfiguration'

attr_tls_inspection_configuration_arn

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

CloudformationAttribute:: TLSInspectionConfigurationArn

attr_tls_inspection_configuration_id

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.

CloudformationAttribute:: TLSInspectionConfigurationId

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: A description of the TLS inspection configuration.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

value pairs to associate with the resource.

Type:: The key

tls_inspection_configuration: The object that defines a TLS inspection configuration.

tls_inspection_configuration_name: The descriptive name of the TLS inspection configuration.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AddressProperty

class CfnTLSInspectionConfiguration.AddressProperty(*, address_definition)

Bases: object

A single IP address specification.

This is used in the MatchAttributes source and destination settings.

Parameters:: address_definition (str) – 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 .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-address.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

address_property = networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
    address_definition="addressDefinition"
)

Attributes

address_definition

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-address.html#cfn-networkfirewall-tlsinspectionconfiguration-address-addressdefinition

CheckCertificateRevocationStatusProperty

class CfnTLSInspectionConfiguration.CheckCertificateRevocationStatusProperty(*, revoked_status_action=None, unknown_status_action=None)

Bases: object

When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status.

If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration .

Parameters:

revoked_status_action (Optional[str]) – Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status. - PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection. - DROP - Network Firewall closes the connection and drops subsequent packets for that connection. - REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.
unknown_status_action (Optional[str]) – Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate. - PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection. - DROP - Network Firewall closes the connection and drops subsequent packets for that connection. - REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

check_certificate_revocation_status_property = networkfirewall.CfnTLSInspectionConfiguration.CheckCertificateRevocationStatusProperty(
    revoked_status_action="revokedStatusAction",
    unknown_status_action="unknownStatusAction"
)

Attributes

revoked_status_action

Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status.

PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html#cfn-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus-revokedstatusaction

unknown_status_action

Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate.

PASS - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection.
DROP - Network Firewall closes the connection and drops subsequent packets for that connection.
REJECT - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. REJECT is available only for TCP traffic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html#cfn-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus-unknownstatusaction

PortRangeProperty

class CfnTLSInspectionConfiguration.PortRangeProperty(*, from_port, to_port)

Bases: object

A single port range specification.

This is used for source and destination port ranges in the stateless rule MatchAttributes , SourcePorts , and DestinationPorts settings.

Parameters:

from_port (Union[int, float]) – The lower limit of the port range. This must be less than or equal to the ToPort specification.
to_port (Union[int, float]) – The upper limit of the port range. This must be greater than or equal to the FromPort specification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

port_range_property = networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
    from_port=123,
    to_port=123
)

Attributes

from_port

The lower limit of the port range.

This must be less than or equal to the ToPort specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html#cfn-networkfirewall-tlsinspectionconfiguration-portrange-fromport

to_port

The upper limit of the port range.

This must be greater than or equal to the FromPort specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html#cfn-networkfirewall-tlsinspectionconfiguration-portrange-toport

ServerCertificateConfigurationProperty

class CfnTLSInspectionConfiguration.ServerCertificateConfigurationProperty(*, certificate_authority_arn=None, check_certificate_revocation_status=None, scopes=None, server_certificates=None)

Bases: object

Configures the AWS Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration . You can configure ServerCertificates for inbound SSL/TLS inspection, a CertificateAuthorityArn for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see Using SSL/TLS server certficiates with TLS inspection configurations in the AWS Network Firewall Developer Guide .

If a server certificate that’s associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.

Parameters:

certificate_authority_arn (Optional[str]) – The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within AWS Certificate Manager (ACM) to use for outbound SSL/TLS inspection. The following limitations apply: - You can use CA certificates that you imported into ACM, but you can’t generate CA certificates with ACM. - You can’t use certificates issued by AWS Private Certificate Authority . For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the AWS Network Firewall Developer Guide . For information about working with certificates in ACM, see Importing certificates in the AWS Certificate Manager User Guide .
check_certificate_revocation_status (Union[IResolvable, CheckCertificateRevocationStatusProperty, Dict[str, Any], None]) –
When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration .
scopes (Union[IResolvable, Sequence[Union[IResolvable, ServerCertificateScopeProperty, Dict[str, Any]]], None]) – A list of scopes.
server_certificates (Union[IResolvable, Sequence[Union[IResolvable, ServerCertificateProperty, Dict[str, Any]]], None]) – The list of server certificates to use for inbound SSL/TLS inspection.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

server_certificate_configuration_property = networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateConfigurationProperty(
    certificate_authority_arn="certificateAuthorityArn",
    check_certificate_revocation_status=networkfirewall.CfnTLSInspectionConfiguration.CheckCertificateRevocationStatusProperty(
        revoked_status_action="revokedStatusAction",
        unknown_status_action="unknownStatusAction"
    ),
    scopes=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateScopeProperty(
        destination_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
            from_port=123,
            to_port=123
        )],
        destinations=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
            address_definition="addressDefinition"
        )],
        protocols=[123],
        source_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
            from_port=123,
            to_port=123
        )],
        sources=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
            address_definition="addressDefinition"
        )]
    )],
    server_certificates=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateProperty(
        resource_arn="resourceArn"
    )]
)

Attributes

certificate_authority_arn

The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within AWS Certificate Manager (ACM) to use for outbound SSL/TLS inspection.

The following limitations apply:

You can use CA certificates that you imported into ACM, but you can’t generate CA certificates with ACM.
You can’t use certificates issued by AWS Private Certificate Authority .

For more information about configuring certificates for outbound inspection, see Using SSL/TLS certificates with certificates with TLS inspection configurations in the AWS Network Firewall Developer Guide .

For information about working with certificates in ACM, see Importing certificates in the AWS Certificate Manager User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-certificateauthorityarn

check_certificate_revocation_status

When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status.

If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a CertificateAuthorityArn in ServerCertificateConfiguration .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-checkcertificaterevocationstatus

scopes

A list of scopes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-scopes

server_certificates

The list of server certificates to use for inbound SSL/TLS inspection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-servercertificates

ServerCertificateProperty

class CfnTLSInspectionConfiguration.ServerCertificateProperty(*, resource_arn=None)

Bases: object

Any AWS Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that’s associated with a ServerCertificateConfiguration . Used in a TLSInspectionConfiguration for inspection of inbound traffic to your firewall. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. AWS 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 AWS Certificate Manager , see Request a public certificate or Importing certificates in the AWS Certificate Manager User Guide .

Parameters:: resource_arn (Optional[str]) – The Amazon Resource Name (ARN) of the AWS Certificate Manager SSL/TLS server certificate that’s used for inbound SSL/TLS inspection.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificate.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

server_certificate_property = networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateProperty(
    resource_arn="resourceArn"
)

Attributes

resource_arn

The Amazon Resource Name (ARN) of the AWS Certificate Manager SSL/TLS server certificate that’s used for inbound SSL/TLS inspection.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificate.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificate-resourcearn

ServerCertificateScopeProperty

class CfnTLSInspectionConfiguration.ServerCertificateScopeProperty(*, destination_ports=None, destinations=None, protocols=None, source_ports=None, sources=None)

Bases: object

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.

Parameters:

destination_ports (Union[IResolvable, Sequence[Union[IResolvable, PortRangeProperty, Dict[str, Any]]], None]) – 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 .
destinations (Union[IResolvable, Sequence[Union[IResolvable, AddressProperty, Dict[str, Any]]], None]) – The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any destination address.
protocols (Union[IResolvable, Sequence[Union[int, float]], None]) – The protocols to decrypt for inspection, specified using each protocol’s assigned internet protocol number (IANA). Network Firewall currently supports only TCP.
source_ports (Union[IResolvable, Sequence[Union[IResolvable, PortRangeProperty, Dict[str, Any]]], None]) – 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 .
sources (Union[IResolvable, Sequence[Union[IResolvable, AddressProperty, Dict[str, Any]]], None]) – The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this matches with any source address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

server_certificate_scope_property = networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateScopeProperty(
    destination_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
        from_port=123,
        to_port=123
    )],
    destinations=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
        address_definition="addressDefinition"
    )],
    protocols=[123],
    source_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
        from_port=123,
        to_port=123
    )],
    sources=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
        address_definition="addressDefinition"
    )]
)

Attributes

destination_ports

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-destinationports

destinations

The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation.

If not specified, this matches with any destination address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-destinations

protocols

The protocols to decrypt for inspection, specified using each protocol’s assigned internet protocol number (IANA).

Network Firewall currently supports only TCP.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-protocols

source_ports

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-sourceports

sources

The source IP addresses and address ranges to decrypt for inspection, in CIDR notation.

If not specified, this matches with any source address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-sources

TLSInspectionConfigurationProperty

class CfnTLSInspectionConfiguration.TLSInspectionConfigurationProperty(*, server_certificate_configurations=None)

Bases: object

The object that defines a TLS inspection configuration. This defines the TLS inspection configuration.

AWS 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 AWS Network Firewall Developer Guide .

Parameters:: server_certificate_configurations (Union[IResolvable, Sequence[Union[IResolvable, ServerCertificateConfigurationProperty, Dict[str, Any]]], None]) – Lists the server certificate configurations that are associated with the TLS configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_networkfirewall as networkfirewall

t_lSInspection_configuration_property = networkfirewall.CfnTLSInspectionConfiguration.TLSInspectionConfigurationProperty(
    server_certificate_configurations=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateConfigurationProperty(
        certificate_authority_arn="certificateAuthorityArn",
        check_certificate_revocation_status=networkfirewall.CfnTLSInspectionConfiguration.CheckCertificateRevocationStatusProperty(
            revoked_status_action="revokedStatusAction",
            unknown_status_action="unknownStatusAction"
        ),
        scopes=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateScopeProperty(
            destination_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
                from_port=123,
                to_port=123
            )],
            destinations=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
                address_definition="addressDefinition"
            )],
            protocols=[123],
            source_ports=[networkfirewall.CfnTLSInspectionConfiguration.PortRangeProperty(
                from_port=123,
                to_port=123
            )],
            sources=[networkfirewall.CfnTLSInspectionConfiguration.AddressProperty(
                address_definition="addressDefinition"
            )]
        )],
        server_certificates=[networkfirewall.CfnTLSInspectionConfiguration.ServerCertificateProperty(
            resource_arn="resourceArn"
        )]
    )]
)

Attributes

server_certificate_configurations

Lists the server certificate configurations that are associated with the TLS configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration-servercertificateconfigurations