Package software.amazon.awscdk.services.appsync

Class CfnDomainNameApiAssociation

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.CfnDomainNameApiAssociation

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:58.926Z")
@Stability(Stable)
public class CfnDomainNameApiAssociation
extends CfnResource
implements IInspectable, IDomainNameApiAssociationRef

The AWS::AppSync::DomainNameApiAssociation resource represents the mapping of your custom domain name to the assigned API URL.

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.*;
 CfnDomainNameApiAssociation cfnDomainNameApiAssociation = CfnDomainNameApiAssociation.Builder.create(this, "MyCfnDomainNameApiAssociation")
         .apiId("apiId")
         .domainName("domainName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

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.interfaces.appsync.IDomainNameApiAssociationRef

IDomainNameApiAssociationRef.Jsii$Default, IDomainNameApiAssociationRef.Jsii$Proxy

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	CfnDomainNameApiAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDomainNameApiAssociation(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDomainNameApiAssociation(software.constructs.Construct scope, String id, CfnDomainNameApiAssociationProps props)	Create a new AWS::AppSync::DomainNameApiAssociation.

Method Summary

Modifier and Type	Method	Description
String	getApiId()	The API ID.
String	getAttrApiAssociationIdentifier()
protected Map<String,Object>	getCfnProperties()
String	getDomainName()	The domain name.
DomainNameApiAssociationReference	getDomainNameApiAssociationRef()	A reference to a DomainNameApiAssociation resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApiId(String value)	The API ID.
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, getEnv, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

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

CfnDomainNameApiAssociation

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

CfnDomainNameApiAssociation

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

CfnDomainNameApiAssociation

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

Create a new AWS::AppSync::DomainNameApiAssociation.

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.

getAttrApiAssociationIdentifier

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getDomainNameApiAssociationRef

@Stability(Stable)
@NotNull
public DomainNameApiAssociationReference getDomainNameApiAssociationRef()

A reference to a DomainNameApiAssociation resource.

Specified by:

getDomainNameApiAssociationRef in interface IDomainNameApiAssociationRef

getApiId

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

The API ID.

setApiId

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

The API ID.

getDomainName

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

The domain name.

setDomainName

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

The domain name.