aws-cdk-lib.aws_apigatewayv2.MTLSConfig

MTLSConfig Struct

The mTLS authentication configuration for a custom domain name.

Source

aws-apigatewayv2/lib/common/domain-name.ts

Type last changed

v2.112.0 · 1 Dec 2023

Example

import * as s3 from 'aws-cdk-lib/aws-s3';
import * as acm from 'aws-cdk-lib/aws-certificatemanager';

const certArn = 'arn:aws:acm:us-east-1:111111111111:certificate';
const domainName = 'example.com';
declare const bucket: s3.Bucket;

new apigwv2.DomainName(this, 'DomainName', {
  domainName,
  certificate: acm.Certificate.fromCertificateArn(this, 'cert', certArn),
  mtls: {
    bucket,
    key: 'someca.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.

version?optionalstringversion?optionalstrversion?optionalStringVersion?optionalstringVersion?optional*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.