Class CfnDomainName.MutualTlsAuthenticationProperty
If specified, API Gateway performs two-way authentication between the client and the server.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class MutualTlsAuthenticationProperty : Object, CfnDomainName.IMutualTlsAuthenticationProperty
Syntax (vb)
Public Class MutualTlsAuthenticationProperty
Inherits Object
Implements CfnDomainName.IMutualTlsAuthenticationProperty
Remarks
Clients must present a trusted certificate to access your API.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
var mutualTlsAuthenticationProperty = new MutualTlsAuthenticationProperty {
TruststoreUri = "truststoreUri",
TruststoreVersion = "truststoreVersion"
};
Synopsis
Constructors
MutualTlsAuthenticationProperty() |
Properties
TruststoreUri | An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, |
TruststoreVersion | The version of the S3 object that contains your truststore. |
Constructors
MutualTlsAuthenticationProperty()
public MutualTlsAuthenticationProperty()
Properties
TruststoreUri
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3:// bucket-name / key-name
.
public string TruststoreUri { get; set; }
Property Value
System.String
Remarks
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
The version of the S3 object that contains your truststore.
public string TruststoreVersion { get; set; }
Property Value
System.String
Remarks
To specify a version, you must have versioning enabled for the S3 bucket.