software.amazon.awscdk.services.apigateway

Interface CfnDomainNameProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomainNameProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.106Z")
 @Stability(value=Stable)
public interface CfnDomainNameProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDomainName`.

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.*;
 CfnDomainNameProps cfnDomainNameProps = CfnDomainNameProps.builder()
         .certificateArn("certificateArn")
         .domainName("domainName")
         .endpointConfiguration(EndpointConfigurationProperty.builder()
                 .types(List.of("types"))
                 .build())
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
         .regionalCertificateArn("regionalCertificateArn")
         .securityPolicy("securityPolicy")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDomainNameProps.Builder	builder()
default String	getCertificateArn() The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name.
default String	getDomainName() The custom domain name for your API.
default Object	getEndpointConfiguration() A list of the endpoint types of the domain name.
default Object	getMutualTlsAuthentication() The mutual TLS authentication configuration for a custom domain name.
default String	getOwnershipVerificationCertificateArn() The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
default String	getRegionalCertificateArn() The reference to an AWS -managed certificate for use by the regional endpoint for the domain name.
default String	getSecurityPolicy() The Transport Layer Security (TLS) version + cipher suite for this domain name.
default List<CfnTag>	getTags() An array of arbitrary tags (key-value pairs) to associate with the domain name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificateArn

@Stability(value=Stable)
 @Nullable
default String getCertificateArn()

The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see Get Certificates Ready in AWS Certificate Manager in the API Gateway Developer Guide .

getDomainName

@Stability(value=Stable)
 @Nullable
default String getDomainName()

The custom domain name for your API.

Uppercase letters are not supported.

getEndpointConfiguration

@Stability(value=Stable)
 @Nullable
default Object getEndpointConfiguration()

A list of the endpoint types of the domain name.

getMutualTlsAuthentication

@Stability(value=Stable)
 @Nullable
default Object getMutualTlsAuthentication()

The mutual TLS authentication configuration for a custom domain name.

getOwnershipVerificationCertificateArn

@Stability(value=Stable)
 @Nullable
default String getOwnershipVerificationCertificateArn()

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.

getRegionalCertificateArn

@Stability(value=Stable)
 @Nullable
default String getRegionalCertificateArn()

The reference to an AWS -managed certificate for use by the regional endpoint for the domain name.

AWS Certificate Manager is the only supported source.

getSecurityPolicy

@Stability(value=Stable)
 @Nullable
default String getSecurityPolicy()

The Transport Layer Security (TLS) version + cipher suite for this domain name.

Valid values include TLS_1_0 and TLS_1_2 .

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

An array of arbitrary tags (key-value pairs) to associate with the domain name.

builder

@Stability(value=Stable)
static CfnDomainNameProps.Builder builder()

Returns:

a CfnDomainNameProps.Builder of CfnDomainNameProps