aws-cdk-lib.aws_apigateway.MTLSConfig

interface MTLSConfig

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.MTLSConfig
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#MTLSConfig
Javasoftware.amazon.awscdk.services.apigateway.MTLSConfig
Pythonaws_cdk.aws_apigateway.MTLSConfig
TypeScript (source)aws-cdk-lib » 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

NameTypeDescription
bucketIBucketThe bucket that the trust store is hosted in.
keystringThe key in S3 to look at for the trust store.
version?stringThe 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.