MutualTlsAuthenticationProperty Struct
If specified, API Gateway performs two-way authentication between the client and the server.
Clients must present a trusted certificate to access your API.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
const mutualTlsAuthenticationProperty: apigatewayv2.CfnDomainName.MutualTlsAuthenticationProperty = {
truststoreUri: 'truststoreUri',
truststoreVersion: 'truststoreVersion',
};
Properties
truststoreUrioptionalstringtruststore_urioptionalstrtruststoreUrioptionalStringTruststoreUrioptionalstringTruststoreUrioptional*string#An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, `s3:// bucket-name / key-name` .
notes
The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
truststoreVersionoptionalstringtruststore_versionoptionalstrtruststoreVersionoptionalStringTruststoreVersionoptionalstringTruststoreVersionoptional*string#The version of the S3 object that contains your truststore.
To specify a version, you must have versioning enabled for the S3 bucket.