Package software.amazon.awscdk.services.apigateway

Interface CfnDomainName.MutualTlsAuthenticationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainName.MutualTlsAuthenticationProperty.Jsii$Proxy

Enclosing class:

CfnDomainName

@Stability(Stable)
public static interface CfnDomainName.MutualTlsAuthenticationProperty
extends software.amazon.jsii.JsiiSerializable

The mutual TLS authentication configuration for a custom domain name.

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 software.amazon.awscdk.services.apigateway.*;
 MutualTlsAuthenticationProperty mutualTlsAuthenticationProperty = MutualTlsAuthenticationProperty.builder()
         .truststoreUri("truststoreUri")
         .truststoreVersion("truststoreVersion")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDomainName.MutualTlsAuthenticationProperty.Builder	A builder for CfnDomainName.MutualTlsAuthenticationProperty
static final class	CfnDomainName.MutualTlsAuthenticationProperty.Jsii$Proxy	An implementation for CfnDomainName.MutualTlsAuthenticationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDomainName.MutualTlsAuthenticationProperty.Builder	builder()
default String	getTruststoreUri()	An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name .
default String	getTruststoreVersion()	The version of the S3 object that contains your truststore.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTruststoreUri

@Stability(Stable)
@Nullable
default String getTruststoreUri()

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.

See Also:

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

getTruststoreVersion

@Stability(Stable)
@Nullable
default String getTruststoreVersion()

The version of the S3 object that contains your truststore.

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

See Also:

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

builder

@Stability(Stable)
static CfnDomainName.MutualTlsAuthenticationProperty.Builder builder()

Returns:

a CfnDomainName.MutualTlsAuthenticationProperty.Builder of CfnDomainName.MutualTlsAuthenticationProperty