software.amazon.awscdk.services.apigatewayv2

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.apigatewayv2.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.258Z")
 @Stability(value=Stable)
public class CfnDomainName
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGatewayV2::DomainName`.

The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (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.apigatewayv2.*;
 Object tags;
 CfnDomainName cfnDomainName = CfnDomainName.Builder.create(this, "MyCfnDomainName")
         .domainName("domainName")
         // the properties below are optional
         .domainNameConfigurations(List.of(DomainNameConfigurationProperty.builder()
                 .certificateArn("certificateArn")
                 .certificateName("certificateName")
                 .endpointType("endpointType")
                 .ownershipVerificationCertificateArn("ownershipVerificationCertificateArn")
                 .securityPolicy("securityPolicy")
                 .build()))
         .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                 .truststoreUri("truststoreUri")
                 .truststoreVersion("truststoreVersion")
                 .build())
         .tags(tags)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDomainName.Builder A fluent builder for CfnDomainName.
static interface	CfnDomainName.DomainNameConfigurationProperty The `DomainNameConfiguration` property type specifies the configuration for a an API's 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, CfnDomainNameProps props) Create a new `AWS::ApiGatewayV2::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	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.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() The custom domain name for your API in Amazon API Gateway.
Object	getDomainNameConfigurations() The domain name configurations.
Object	getMutualTlsAuthentication() The mutual TLS authentication configuration for a custom domain name.
TagManager	getTags() The collection of tags associated with a domain name.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomainName(String value) The custom domain name for your API in Amazon API Gateway.
void	setDomainNameConfigurations(IResolvable value) The domain name configurations.
void	setDomainNameConfigurations(List<Object> value) The domain name configurations.
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.

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,
                                              @NotNull
                                              CfnDomainNameProps props)

Create a new `AWS::ApiGatewayV2::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. 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.

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()

The collection of tags associated with a domain name.

getDomainName

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

The custom domain name for your API in Amazon API Gateway.

Uppercase letters are not supported.

setDomainName

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

The custom domain name for your API in Amazon API Gateway.

Uppercase letters are not supported.

getDomainNameConfigurations

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

The domain name configurations.

setDomainNameConfigurations

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

The domain name configurations.

setDomainNameConfigurations

@Stability(value=Stable)
public void setDomainNameConfigurations(@Nullable
                                                                 List<Object> value)

The domain name configurations.

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.