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.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.748Z")
 @Stability(value=Stable)
public class CfnDomainName
extends CfnResource
implements IInspectable

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

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 Example:
static interface	CfnDomainName.MutualTlsAuthenticationProperty Example:

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()
String	getAttrDistributionHostedZoneId()
String	getAttrRegionalDomainName()
String	getAttrRegionalHostedZoneId()
String	getCertificateArn() `AWS::ApiGateway::DomainName.CertificateArn`.
protected Map<String,Object>	getCfnProperties()
String	getDomainName() `AWS::ApiGateway::DomainName.DomainName`.
Object	getEndpointConfiguration() `AWS::ApiGateway::DomainName.EndpointConfiguration`.
Object	getMutualTlsAuthentication() `AWS::ApiGateway::DomainName.MutualTlsAuthentication`.
String	getOwnershipVerificationCertificateArn() `AWS::ApiGateway::DomainName.OwnershipVerificationCertificateArn`.
String	getRegionalCertificateArn() `AWS::ApiGateway::DomainName.RegionalCertificateArn`.
String	getSecurityPolicy() `AWS::ApiGateway::DomainName.SecurityPolicy`.
TagManager	getTags() `AWS::ApiGateway::DomainName.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificateArn(String value) `AWS::ApiGateway::DomainName.CertificateArn`.
void	setDomainName(String value) `AWS::ApiGateway::DomainName.DomainName`.
void	setEndpointConfiguration(CfnDomainName.EndpointConfigurationProperty value) `AWS::ApiGateway::DomainName.EndpointConfiguration`.
void	setEndpointConfiguration(IResolvable value) `AWS::ApiGateway::DomainName.EndpointConfiguration`.
void	setMutualTlsAuthentication(CfnDomainName.MutualTlsAuthenticationProperty value) `AWS::ApiGateway::DomainName.MutualTlsAuthentication`.
void	setMutualTlsAuthentication(IResolvable value) `AWS::ApiGateway::DomainName.MutualTlsAuthentication`.
void	setOwnershipVerificationCertificateArn(String value) `AWS::ApiGateway::DomainName.OwnershipVerificationCertificateArn`.
void	setRegionalCertificateArn(String value) `AWS::ApiGateway::DomainName.RegionalCertificateArn`.
void	setSecurityPolicy(String value) `AWS::ApiGateway::DomainName.SecurityPolicy`.

Methods inherited from class software.amazon.awscdk.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.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()

getAttrDistributionHostedZoneId

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

getAttrRegionalDomainName

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

getAttrRegionalHostedZoneId

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

getCertificateArn

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

`AWS::ApiGateway::DomainName.CertificateArn`.

setCertificateArn

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

`AWS::ApiGateway::DomainName.CertificateArn`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDomainName

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

`AWS::ApiGateway::DomainName.DomainName`.

setDomainName

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

`AWS::ApiGateway::DomainName.DomainName`.

getEndpointConfiguration

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

`AWS::ApiGateway::DomainName.EndpointConfiguration`.

setEndpointConfiguration

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

`AWS::ApiGateway::DomainName.EndpointConfiguration`.

setEndpointConfiguration

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

`AWS::ApiGateway::DomainName.EndpointConfiguration`.

getMutualTlsAuthentication

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

`AWS::ApiGateway::DomainName.MutualTlsAuthentication`.

setMutualTlsAuthentication

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

`AWS::ApiGateway::DomainName.MutualTlsAuthentication`.

setMutualTlsAuthentication

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

`AWS::ApiGateway::DomainName.MutualTlsAuthentication`.

getOwnershipVerificationCertificateArn

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

`AWS::ApiGateway::DomainName.OwnershipVerificationCertificateArn`.

setOwnershipVerificationCertificateArn

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

`AWS::ApiGateway::DomainName.OwnershipVerificationCertificateArn`.

getRegionalCertificateArn

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

`AWS::ApiGateway::DomainName.RegionalCertificateArn`.

setRegionalCertificateArn

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

`AWS::ApiGateway::DomainName.RegionalCertificateArn`.

getSecurityPolicy

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

`AWS::ApiGateway::DomainName.SecurityPolicy`.

setSecurityPolicy

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

`AWS::ApiGateway::DomainName.SecurityPolicy`.

getTags

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

`AWS::ApiGateway::DomainName.Tags`.