Package software.amazon.awscdk.services.lightsail

Class CfnDomain

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.lightsail.CfnDomain
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDomainRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:24.672Z") @Stability(Stable) public class CfnDomain extends CfnResource implements IInspectable, IDomainRef, ITaggableV2
Describes a domain where you are storing recordsets.

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.lightsail.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .domainName("domainName")
         // the properties below are optional
         .domainEntries(List.of(DomainEntryProperty.builder()
                 .name("name")
                 .target("target")
                 .type("type")
                 // the properties below are optional
                 .id("id")
                 .isAlias(false)
                 .build()))
         .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

    • CfnDomain

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

    • CfnDomain

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

    • CfnDomain

      @Stability(Stable) public CfnDomain(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDomainProps props)
      Create a new AWS::Lightsail::Domain.

      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

    • arnForDomain

      @Stability(Stable) @NotNull public static String arnForDomain(@NotNull IDomainRef resource)
      Parameters:
      resource - 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the domain recordset ( arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE ).

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date when the domain recordset was created.

    • getAttrLocation

      @Stability(Stable) @NotNull public IResolvable getAttrLocation()
      The AWS Region and Availability Zone where the domain was created (read-only).

    • getAttrResourceType

      @Stability(Stable) @NotNull public String getAttrResourceType()
      The resource type.

    • getAttrSupportCode

      @Stability(Stable) @NotNull public String getAttrSupportCode()
      The support code.

      Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

    • 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

    • getDomainRef

      @Stability(Stable) @NotNull public DomainReference getDomainRef()
      A reference to a Domain resource.
      Specified by:
      getDomainRef in interface IDomainRef

    • getDomainName

      @Stability(Stable) @NotNull public String getDomainName()
      The fully qualified domain name in the certificate request.

    • setDomainName

      @Stability(Stable) public void setDomainName(@NotNull String value)
      The fully qualified domain name in the certificate request.

    • getDomainEntries

      @Stability(Stable) @Nullable public Object getDomainEntries()
      An array of key-value pairs containing information about the domain entries.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDomain.DomainEntryProperty>

    • setDomainEntries

      @Stability(Stable) public void setDomainEntries(@Nullable IResolvable value)
      An array of key-value pairs containing information about the domain entries.

    • setDomainEntries

      @Stability(Stable) public void setDomainEntries(@Nullable List<Object> value)
      An array of key-value pairs containing information about the domain entries.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tag keys and optional values for the resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tag keys and optional values for the resource.