Class CfnDomainName.MutualTlsAuthenticationProperty

The mutual TLS authentication configuration for a custom domain name.

Inheritance

System.Object

CfnDomainName.MutualTlsAuthenticationProperty

Implements

CfnDomainName.IMutualTlsAuthenticationProperty

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class MutualTlsAuthenticationProperty : Object, CfnDomainName.IMutualTlsAuthenticationProperty

Syntax (vb)

Public Class MutualTlsAuthenticationProperty
    Inherits Object
    Implements CfnDomainName.IMutualTlsAuthenticationProperty

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.

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

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.APIGateway;

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 `s3://bucket-name/key-name` .
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.

See: 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

System.String

Remarks

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

Implements

CfnDomainName.IMutualTlsAuthenticationProperty