MTLSConfig

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

Bases: object

The mTLS authentication configuration for a custom domain name.

Parameters:

bucket (IBucket) – The bucket that the trust store is hosted in.
key (str) – The key in S3 to look at for the trust store.
version (Optional[str]) – 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

ExampleMetadata:

infused

Example:

# acm: Any


apigateway.DomainName(self, "domain-name",
    domain_name="example.com",
    certificate=acm.Certificate.from_certificate_arn(self, "cert", "arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d"),
    mtls=apigateway.MTLSConfig(
        bucket=s3.Bucket(self, "bucket"),
        key="truststore.pem",
        version="version"
    )
)

Attributes

bucket: The bucket that the trust store is hosted in.

key: The key in S3 to look at for the trust store.

version

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