software.amazon.awscdk.services.apigateway

Class CfnDomainName

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigateway.CfnDomainName

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.500Z")
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 The mutual TLS authentication configuration for a custom domain name.

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDomainName(Construct scope, java.lang.String id) Create a new `AWS::ApiGateway::DomainName`.
	CfnDomainName(Construct scope, java.lang.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
java.lang.String	getAttrDistributionDomainName() The Amazon CloudFront distribution domain name that's mapped to the custom domain name.
java.lang.String	getAttrDistributionHostedZoneId() The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
java.lang.String	getAttrRegionalDomainName() The domain name associated with the regional endpoint for this custom domain name.
java.lang.String	getAttrRegionalHostedZoneId() The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
java.lang.String	getCertificateArn() The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDomainName() The custom domain name as an API host name, for example, `my-api.example.com` .
java.lang.Object	getEndpointConfiguration() The endpoint configuration of this DomainName showing the endpoint types of the domain name.
java.lang.Object	getMutualTlsAuthentication() The mutual TLS authentication configuration for a custom domain name.
java.lang.String	getOwnershipVerificationCertificateArn() The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
java.lang.String	getRegionalCertificateArn() The reference to an AWS -managed certificate that will be used for validating the regional domain name.
java.lang.String	getSecurityPolicy() The Transport Layer Security (TLS) version + cipher suite for this DomainName.
TagManager	getTags() The collection of tags.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCertificateArn(java.lang.String value) The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
void	setDomainName(java.lang.String value) The custom domain name as an API host name, for example, `my-api.example.com` .
void	setEndpointConfiguration(CfnDomainName.EndpointConfigurationProperty value) The endpoint configuration of this DomainName showing the endpoint types of the domain name.
void	setEndpointConfiguration(IResolvable value) The endpoint configuration of this DomainName showing 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(java.lang.String value) The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
void	setRegionalCertificateArn(java.lang.String value) The reference to an AWS -managed certificate that will be used for validating the regional domain name.
void	setSecurityPolicy(java.lang.String value) The Transport Layer Security (TLS) version + cipher suite for this DomainName.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnDomainName(Construct scope,
                     java.lang.String id,
                     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

public CfnDomainName(Construct scope,
                     java.lang.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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrDistributionDomainName

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

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

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

public java.lang.String getAttrRegionalHostedZoneId()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The collection of tags.

Each tag element is associated with a given resource.

getCertificateArn

public java.lang.String getCertificateArn()

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source.

setCertificateArn

public void setCertificateArn(java.lang.String value)

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source.

getDomainName

public java.lang.String getDomainName()

The custom domain name as an API host name, for example, `my-api.example.com` .

setDomainName

public void setDomainName(java.lang.String value)

The custom domain name as an API host name, for example, `my-api.example.com` .

getEndpointConfiguration

public java.lang.Object getEndpointConfiguration()

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

setEndpointConfiguration

public void setEndpointConfiguration(IResolvable value)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

setEndpointConfiguration

public void setEndpointConfiguration(CfnDomainName.EndpointConfigurationProperty value)

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

getMutualTlsAuthentication

public java.lang.Object getMutualTlsAuthentication()

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.

setMutualTlsAuthentication

public void setMutualTlsAuthentication(IResolvable value)

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.

setMutualTlsAuthentication

public void setMutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty value)

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.

getOwnershipVerificationCertificateArn

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

public void setOwnershipVerificationCertificateArn(java.lang.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

public java.lang.String getRegionalCertificateArn()

The reference to an AWS -managed certificate that will be used for validating the regional domain name.

AWS Certificate Manager is the only supported source.

setRegionalCertificateArn

public void setRegionalCertificateArn(java.lang.String value)

The reference to an AWS -managed certificate that will be used for validating the regional domain name.

AWS Certificate Manager is the only supported source.

getSecurityPolicy

public java.lang.String getSecurityPolicy()

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

The valid values are TLS_1_0 and TLS_1_2 .

setSecurityPolicy

public void setSecurityPolicy(java.lang.String value)

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

The valid values are TLS_1_0 and TLS_1_2 .