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:
IEnvironmentAware, IInspectable, ITaggableV2, IDomainNameRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:34.528Z") @Stability(Stable) public class CfnDomainName extends CfnResource implements IInspectable, IDomainNameRef, ITaggableV2
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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • fromDomainName

      @Stability(Stable) @NotNull public static IDomainNameRef fromDomainName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String domainName)
      Creates a new IDomainNameRef from a domainName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      domainName - This parameter is required.

    • fromDomainNameArn

      @Stability(Stable) @NotNull public static IDomainNameRef fromDomainNameArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IDomainNameRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

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

    • getAttrDomainNameArn

      @Stability(Stable) @NotNull public String getAttrDomainNameArn()
      The Amazon resource name (ARN) of the domain name.

    • getAttrHostedZoneId

      @Stability(Stable) @NotNull public String getAttrHostedZoneId()
      The ID of your Amazon Route 53 hosted zone.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDomainNameRef

      @Stability(Stable) @NotNull public DomainNameReference getDomainNameRef()
      A reference to a DomainName resource.
      Specified by:
      getDomainNameRef in interface IDomainNameRef

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

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A set of tags (key-value pairs) for this domain name.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A set of tags (key-value pairs) for this domain name.