software.amazon.awscdk.services.appsync

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:12.538Z")
public class CfnDomainName
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppSync::DomainName`.

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

Nested Class Summary

Nested Classes

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

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, CfnDomainNameProps props) Create a new `AWS::AppSync::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	getAttrAppSyncDomainName() The domain name provided by AWS AppSync .
java.lang.String	getAttrDomainName() The domain name.
java.lang.String	getAttrHostedZoneId() The ID of your Amazon Route 53 hosted zone.
java.lang.String	getCertificateArn() The Amazon Resource Name (ARN) of the certificate.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The decription for your domain name.
java.lang.String	getDomainName() The domain name.
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 Amazon Resource Name (ARN) of the certificate.
void	setDescription(java.lang.String value) The decription for your domain name.
void	setDomainName(java.lang.String value) The domain name.

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::AppSync::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

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.

getAttrAppSyncDomainName

public java.lang.String getAttrAppSyncDomainName()

The domain name provided by AWS AppSync .

getAttrDomainName

public java.lang.String getAttrDomainName()

The domain name.

getAttrHostedZoneId

public java.lang.String getAttrHostedZoneId()

The ID of your Amazon Route 53 hosted zone.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCertificateArn

public java.lang.String getCertificateArn()

The Amazon Resource Name (ARN) of the certificate.

This will be an AWS Certificate Manager certificate.

setCertificateArn

public void setCertificateArn(java.lang.String value)

The Amazon Resource Name (ARN) of the certificate.

This will be an AWS Certificate Manager certificate.

getDomainName

public java.lang.String getDomainName()

The domain name.

setDomainName

public void setDomainName(java.lang.String value)

The domain name.

getDescription

public java.lang.String getDescription()

The decription for your domain name.

setDescription

public void setDescription(java.lang.String value)

The decription for your domain name.