Package software.amazon.awscdk.services.datazone

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.datazone.CfnDomain
All Implemented Interfaces:
IInspectable, ITaggableV2, IDomainRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:08.500Z") @Stability(Stable) public class CfnDomain extends CfnResource implements IInspectable, IDomainRef, ITaggableV2
The AWS::DataZone::Domain resource specifies an Amazon DataZone domain.

You can use domains to organize your assets, users, and their projects.

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.datazone.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .domainExecutionRole("domainExecutionRole")
         .name("name")
         // the properties below are optional
         .description("description")
         .domainVersion("domainVersion")
         .kmsKeyIdentifier("kmsKeyIdentifier")
         .serviceRole("serviceRole")
         .singleSignOn(SingleSignOnProperty.builder()
                 .idcInstanceArn("idcInstanceArn")
                 .type("type")
                 .userAssignment("userAssignment")
                 .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)
      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

    • fromDomainArn

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

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

    • fromDomainId

      @Stability(Stable) @NotNull public static IDomainRef fromDomainId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String domainId)
      Creates a new IDomainRef from a domainId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      domainId - 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 ARN of the Amazon DataZone domain.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      A timestamp of when a Amazon DataZone domain was created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the Amazon DataZone domain.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      A timestamp of when a Amazon DataZone domain was last updated.

    • getAttrManagedAccountId

      @Stability(Stable) @NotNull public String getAttrManagedAccountId()
      The identifier of the AWS account that manages the domain.

    • getAttrPortalUrl

      @Stability(Stable) @NotNull public String getAttrPortalUrl()
      The data portal URL for the Amazon DataZone domain.

    • getAttrRootDomainUnitId

      @Stability(Stable) @NotNull public String getAttrRootDomainUnitId()
      The ID of the root domain unit.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the Amazon DataZone domain.

    • 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

    • getDomainExecutionRole

      @Stability(Stable) @NotNull public String getDomainExecutionRole()
      The domain execution role that is created when an Amazon DataZone domain is created.

    • setDomainExecutionRole

      @Stability(Stable) public void setDomainExecutionRole(@NotNull String value)
      The domain execution role that is created when an Amazon DataZone domain is created.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the Amazon DataZone domain.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the Amazon DataZone domain.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the Amazon DataZone domain.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the Amazon DataZone domain.

    • getDomainVersion

      @Stability(Stable) @Nullable public String getDomainVersion()
      The domain version.

    • setDomainVersion

      @Stability(Stable) public void setDomainVersion(@Nullable String value)
      The domain version.

    • getKmsKeyIdentifier

      @Stability(Stable) @Nullable public String getKmsKeyIdentifier()
      The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

    • setKmsKeyIdentifier

      @Stability(Stable) public void setKmsKeyIdentifier(@Nullable String value)
      The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

    • getServiceRole

      @Stability(Stable) @Nullable public String getServiceRole()
      The service role of the domain.

    • setServiceRole

      @Stability(Stable) public void setServiceRole(@Nullable String value)
      The service role of the domain.

    • getSingleSignOn

      @Stability(Stable) @Nullable public Object getSingleSignOn()
      The single sign-on details in Amazon DataZone.

    • setSingleSignOn

      @Stability(Stable) public void setSingleSignOn(@Nullable IResolvable value)
      The single sign-on details in Amazon DataZone.

    • setSingleSignOn

      @Stability(Stable) public void setSingleSignOn(@Nullable CfnDomain.SingleSignOnProperty value)
      The single sign-on details in Amazon DataZone.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags specified for the Amazon DataZone domain.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags specified for the Amazon DataZone domain.