MTLSConfig

class aws_cdk.aws_apigatewayv2.MTLSConfig(*, bucket, key, version=None)

Bases: object

(experimental) The mTLS authentication configuration for a custom domain name.

Parameters
  • bucket (IBucket) – (experimental) The bucket that the trust store is hosted in.

  • key (str) – (experimental) The key in S3 to look at for the trust store.

  • version (Optional[str]) – (experimental) The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket. Default: - latest version

Stability

experimental

ExampleMetadata

infused

Example:

import aws_cdk.aws_s3 as s3
import aws_cdk.aws_certificatemanager as acm
# bucket: s3.Bucket


cert_arn = "arn:aws:acm:us-east-1:111111111111:certificate"
domain_name = "example.com"

apigwv2.DomainName(self, "DomainName",
    domain_name=domain_name,
    certificate=acm.Certificate.from_certificate_arn(self, "cert", cert_arn),
    mtls=apigwv2.MTLSConfig(
        bucket=bucket,
        key="someca.pem",
        version="version"
    )
)

Attributes

bucket

(experimental) The bucket that the trust store is hosted in.

Stability

experimental

Return type

IBucket

key

(experimental) The key in S3 to look at for the trust store.

Stability

experimental

Return type

str

version

(experimental) The version of the S3 object that contains your truststore.

To specify a version, you must have versioning enabled for the S3 bucket.

Default
  • latest version

Stability

experimental

Return type

Optional[str]