AWS CDK Reference

Appearance

v2.274.0

MTLSConfig Struct ​

The mTLS authentication configuration for a custom domain name.

Source
aws-apigateway/lib/domain-name.ts

Example ​

ts
declare const acm: any;

new apigateway.DomainName(this, 'domain-name', {
  domainName: 'example.com',
  certificate: acm.Certificate.fromCertificateArn(this, 'cert', 'arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d'),
  mtls: {
    bucket: new s3.Bucket(this, 'bucket'),
    key: 'truststore.pem',
    version: 'version',
  },
});

Properties ​

bucketIBucketbucketIBucketbucketIBucketBucketIBucketBucketIBucketrequired#
The bucket that the trust store is hosted in.
keystringkeystrkeyStringKeystringKey*stringrequired#
The key in S3 to look at for the trust store.
versionstringversionstrversionStringVersionstringVersion*string#
The version of the S3 object that contains your truststore.

Default: latest version

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