@aws-cdk_aws-apigatewayv2-alpha.MTLSConfig

interface MTLSConfig ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Apigatewayv2.Alpha.MTLSConfig
Gogithub.com/aws/aws-cdk-go/awscdkapigatewayv2alpha/v2#MTLSConfig
Javasoftware.amazon.awscdk.services.apigatewayv2.alpha.MTLSConfig
Pythonaws_cdk.aws_apigatewayv2_alpha.MTLSConfig
TypeScript (source)@aws-cdk/aws-apigatewayv2-alpha ยป MTLSConfig

The mTLS authentication configuration for a custom domain name.

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

NameTypeDescription
bucket๐Ÿ”นIBucketThe bucket that the trust store is hosted in.
key๐Ÿ”นstringThe 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.