software.amazon.awscdk.services.apigateway

Class CfnDomainName

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnDomainName

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.104Z")
 @Stability(value=Stable)
public class CfnDomainName
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::DomainName`.

The AWS::ApiGateway::DomainName resource specifies a custom domain name for your API in API Gateway.

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

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.*;
 CfnDomainName cfnDomainName = CfnDomainName.Builder.create(this, "MyCfnDomainName")
         .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	Class and Description
static class	CfnDomainName.Builder A fluent builder for CfnDomainName.
static interface	CfnDomainName.EndpointConfigurationProperty The `EndpointConfiguration` property type specifies the endpoint types of an Amazon API Gateway domain name.
static interface	CfnDomainName.MutualTlsAuthenticationProperty If specified, API Gateway performs two-way authentication between the client and the server.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDomainName(software.constructs.Construct scope, String id) Create a new `AWS::ApiGateway::DomainName`.
	CfnDomainName(software.constructs.Construct scope, String id, CfnDomainNameProps props) Create a new `AWS::ApiGateway::DomainName`.
protected	CfnDomainName(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainName(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrDistributionDomainName() The Amazon CloudFront distribution domain name that's mapped to the custom domain name.
String	getAttrDistributionHostedZoneId() The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
String	getAttrRegionalDomainName() The domain name associated with the regional endpoint for this custom domain name.
String	getAttrRegionalHostedZoneId() The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
String	getCertificateArn() The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() The custom domain name for your API.
Object	getEndpointConfiguration() A list of the endpoint types of the domain name.
Object	getMutualTlsAuthentication() The mutual TLS authentication configuration for a custom domain name.
String	getOwnershipVerificationCertificateArn() The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
String	getRegionalCertificateArn() The reference to an AWS -managed certificate for use by the regional endpoint for the domain name.
String	getSecurityPolicy() The Transport Layer Security (TLS) version + cipher suite for this domain name.
TagManager	getTags() An array of arbitrary tags (key-value pairs) to associate with the domain name.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificateArn(String value) The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name.
void	setDomainName(String value) The custom domain name for your API.
void	setEndpointConfiguration(CfnDomainName.EndpointConfigurationProperty value) A list of the endpoint types of the domain name.
void	setEndpointConfiguration(IResolvable value) A list of the endpoint types of the domain name.
void	setMutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty value) The mutual TLS authentication configuration for a custom domain name.
void	setMutualTlsAuthentication(IResolvable value) The mutual TLS authentication configuration for a custom domain name.
void	setOwnershipVerificationCertificateArn(String value) The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
void	setRegionalCertificateArn(String value) The reference to an AWS -managed certificate for use by the regional endpoint for the domain name.
void	setSecurityPolicy(String value) The Transport Layer Security (TLS) version + cipher suite for this domain name.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDomainName

protected CfnDomainName(software.amazon.jsii.JsiiObjectRef objRef)

CfnDomainName

protected CfnDomainName(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDomainName

@Stability(value=Stable)
public CfnDomainName(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @Nullable
                                              CfnDomainNameProps props)

Create a new `AWS::ApiGateway::DomainName`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnDomainName

@Stability(value=Stable)
public CfnDomainName(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id)

Create a new `AWS::ApiGateway::DomainName`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDistributionDomainName

@Stability(value=Stable)
 @NotNull
public String getAttrDistributionDomainName()

The Amazon CloudFront distribution domain name that's mapped to the custom domain name.

This is only applicable for endpoints whose type is EDGE .

Example: d111111abcdef8.cloudfront.net

getAttrDistributionHostedZoneId

@Stability(value=Stable)
 @NotNull
public String getAttrDistributionHostedZoneId()

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.

The only valid value is Z2FDTNDATAQYW2 for all regions.

getAttrRegionalDomainName

@Stability(value=Stable)
 @NotNull
public String getAttrRegionalDomainName()

The domain name associated with the regional endpoint for this custom domain name.

You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

getAttrRegionalHostedZoneId

@Stability(value=Stable)
 @NotNull
public String getAttrRegionalHostedZoneId()

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getCertificateArn

@Stability(value=Stable)
 @Nullable
public 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 .

setCertificateArn

@Stability(value=Stable)
public void setCertificateArn(@Nullable
                                                       String value)

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
public String getDomainName()

The custom domain name for your API.

Uppercase letters are not supported.

setDomainName

@Stability(value=Stable)
public void setDomainName(@Nullable
                                                   String value)

The custom domain name for your API.

Uppercase letters are not supported.

getEndpointConfiguration

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

A list of the endpoint types of the domain name.

setEndpointConfiguration

@Stability(value=Stable)
public void setEndpointConfiguration(@Nullable
                                                              CfnDomainName.EndpointConfigurationProperty value)

A list of the endpoint types of the domain name.

setEndpointConfiguration

@Stability(value=Stable)
public void setEndpointConfiguration(@Nullable
                                                              IResolvable value)

A list of the endpoint types of the domain name.

getMutualTlsAuthentication

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

The mutual TLS authentication configuration for a custom domain name.

setMutualTlsAuthentication

@Stability(value=Stable)
public void setMutualTlsAuthentication(@Nullable
                                                                CfnDomainName.MutualTlsAuthenticationProperty value)

The mutual TLS authentication configuration for a custom domain name.

setMutualTlsAuthentication

@Stability(value=Stable)
public void setMutualTlsAuthentication(@Nullable
                                                                IResolvable value)

The mutual TLS authentication configuration for a custom domain name.

getOwnershipVerificationCertificateArn

@Stability(value=Stable)
 @Nullable
public 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.

setOwnershipVerificationCertificateArn

@Stability(value=Stable)
public void setOwnershipVerificationCertificateArn(@Nullable
                                                                            String value)

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
public 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.

setRegionalCertificateArn

@Stability(value=Stable)
public void setRegionalCertificateArn(@Nullable
                                                               String value)

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
public String getSecurityPolicy()

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

Valid values include TLS_1_0 and TLS_1_2 .

setSecurityPolicy

@Stability(value=Stable)
public void setSecurityPolicy(@Nullable
                                                       String value)

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

Valid values include TLS_1_0 and TLS_1_2 .