Package software.amazon.awscdk.services.appsync

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.appsync.CfnDomainName

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:03.543Z")
@Stability(Stable)
public class CfnDomainName
extends CfnResource
implements IInspectable

The AWS::AppSync::DomainName resource creates a DomainNameConfig object to configure a custom domain.

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.appsync.*;
 CfnDomainName cfnDomainName = CfnDomainName.Builder.create(this, "MyCfnDomainName")
         .certificateArn("certificateArn")
         .domainName("domainName")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-domainname.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDomainName.Builder	A fluent builder for CfnDomainName.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDomainName(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainName(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDomainName(software.constructs.Construct scope, String id, CfnDomainNameProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAppSyncDomainName()	The domain name provided by AWS AppSync .
String	getAttrDomainName()	The domain name.
String	getAttrHostedZoneId()	The ID of your Amazon Route 53 hosted zone.
String	getCertificateArn()	The Amazon Resource Name (ARN) of the certificate.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The decription for your domain name.
String	getDomainName()	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 Amazon Resource Name (ARN) of the certificate.
void	setDescription(String value)	The decription for your domain name.
void	setDomainName(String value)	The domain name.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDomainName

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

CfnDomainName

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

CfnDomainName

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAppSyncDomainName

@Stability(Stable)
@NotNull
public String getAttrAppSyncDomainName()

The domain name provided by AWS AppSync .

getAttrDomainName

@Stability(Stable)
@NotNull
public String getAttrDomainName()

The domain name.

getAttrHostedZoneId

@Stability(Stable)
@NotNull
public String getAttrHostedZoneId()

The ID of your Amazon Route 53 hosted zone.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCertificateArn

@Stability(Stable)
@NotNull
public String getCertificateArn()

The Amazon Resource Name (ARN) of the certificate.

setCertificateArn

@Stability(Stable)
public void setCertificateArn(@NotNull
 String value)

The Amazon Resource Name (ARN) of the certificate.

getDomainName

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

The domain name.

setDomainName

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

The domain name.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The decription for your domain name.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The decription for your domain name.