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
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:06.865Z")
@Stability(Stable)
public class CfnDomain
extends CfnResource
implements IInspectable, 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") .kmsKeyIdentifier("kmsKeyIdentifier") .singleSignOn(SingleSignOnProperty.builder() .type("type") .userAssignment("userAssignment") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDomain
.static interface
The single sign-on details in Amazon DataZone.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.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnDomain
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDomain
(software.amazon.jsii.JsiiObjectRef objRef) CfnDomain
(software.constructs.Construct scope, String id, CfnDomainProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the Amazon DataZone domain.A timestamp of when a Amazon DataZone domain was created.The ID of the Amazon DataZone domain.A timestamp of when a Amazon DataZone domain was last updated.The identifier of the AWS account that manages the domain.The data portal URL for the Amazon DataZone domain.The status of the Amazon DataZone domain.Tag Manager which manages the tags for this resource.The description of the Amazon DataZone domain.The domain execution role that is created when an Amazon DataZone domain is created.The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.getName()
The name of the Amazon DataZone domain.The single sign-on details in Amazon DataZone.getTags()
The tags specified for the Amazon DataZone domain.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description of the Amazon DataZone domain.void
setDomainExecutionRole
(String value) The domain execution role that is created when an Amazon DataZone domain is created.void
setKmsKeyIdentifier
(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.void
The name of the Amazon DataZone domain.void
setSingleSignOn
(IResolvable value) The single sign-on details in Amazon DataZone.void
The single sign-on details in Amazon DataZone.void
The tags specified for the Amazon DataZone domain.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, 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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the Amazon DataZone domain. -
getAttrCreatedAt
A timestamp of when a Amazon DataZone domain was created. -
getAttrId
The ID of the Amazon DataZone domain. -
getAttrLastUpdatedAt
A timestamp of when a Amazon DataZone domain was last updated. -
getAttrManagedAccountId
The identifier of the AWS account that manages the domain. -
getAttrPortalUrl
The data portal URL for the Amazon DataZone domain. -
getAttrStatus
The status of the Amazon DataZone domain. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDomainExecutionRole
The domain execution role that is created when an Amazon DataZone domain is created. -
setDomainExecutionRole
The domain execution role that is created when an Amazon DataZone domain is created. -
getName
The name of the Amazon DataZone domain. -
setName
The name of the Amazon DataZone domain. -
getDescription
The description of the Amazon DataZone domain. -
setDescription
The description of the Amazon DataZone domain. -
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
The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. -
getSingleSignOn
The single sign-on details in Amazon DataZone. -
setSingleSignOn
The single sign-on details in Amazon DataZone. -
setSingleSignOn
The single sign-on details in Amazon DataZone. -
getTags
The tags specified for the Amazon DataZone domain. -
setTags
The tags specified for the Amazon DataZone domain.
-