interface MTLSConfig

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.MTLSConfig
Java	software.amazon.awscdk.services.apigateway.MTLSConfig
Python	aws_cdk.aws_apigateway.MTLSConfig
TypeScript (source)	@aws-cdk/aws-apigateway » MTLSConfig

The mTLS authentication configuration for a custom domain name.

Example

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

Name	Type	Description
bucket	IBucket	The bucket that the trust store is hosted in.
key	string	The key in S3 to look at for the trust store.
version?	string	The version of the S3 object that contains your truststore.

---

bucket

Type: IBucket

The bucket that the trust store is hosted in.

---

key

Type: string

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

---

version?

Type: string (optional, default: latest version)

The version of the S3 object that contains your truststore.

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