interface MutualTlsAuthenticationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Apigatewayv2.CfnDomainName.MutualTlsAuthenticationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsapigatewayv2#CfnDomainName_MutualTlsAuthenticationProperty |
 Java | software.amazon.awscdk.services.apigatewayv2.CfnDomainName.MutualTlsAuthenticationProperty |
 Python | aws_cdk.aws_apigatewayv2.CfnDomainName.MutualTlsAuthenticationProperty |
 TypeScript | aws-cdk-lib » aws_apigatewayv2 » CfnDomainName » MutualTlsAuthenticationProperty |
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
// 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
| Name | Type | Description |
|---|---|---|
| truststore | string | An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3:// bucket-name / key-name . |
| truststore | string | The version of the S3 object that contains your truststore. |
truststoreUri?
Type:
string
(optional)
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3:// bucket-name / key-name .
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.
truststoreVersion?
Type:
string
(optional)
The version of the S3 object that contains your truststore.
To specify a version, you must have versioning enabled for the S3 bucket.