Class CfnDomainName.MutualTlsAuthenticationProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

The mutual TLS authentication configuration for a custom domain name.

public class CfnDomainName.MutualTlsAuthenticationProperty : CfnDomainName.IMutualTlsAuthenticationProperty

Inheritance

object

CfnDomainName.MutualTlsAuthenticationProperty

Implements

CfnDomainName.IMutualTlsAuthenticationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var mutualTlsAuthenticationProperty = new MutualTlsAuthenticationProperty {
                 TruststoreUri = "truststoreUri",
                 TruststoreVersion = "truststoreVersion"
             };

Remarks

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html

ExampleMetadata: fixture=_generated

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

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri

TruststoreVersion

The version of the S3 object that contains your truststore.

public string? TruststoreVersion { get; set; }

Property Value

string

Remarks

To specify a version, you must have versioning enabled for the S3 bucket.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion