AWS::DataZone::Domain - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::DataZone::Domain

The AWS::DataZone::Domainresource specifies an Amazon DataZone domain. You can use domains to organize your assets, users, and their projects.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataZone::Domain",
  "Properties" : {
      "Description" : String,
      "DomainExecutionRole" : String,
      "KmsKeyIdentifier" : String,
      "Name" : String,
      "SingleSignOn" : SingleSignOn,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataZone::Domain
Properties:
  Description: String
  DomainExecutionRole: String
  KmsKeyIdentifier: String
  Name: String
  SingleSignOn: 
    SingleSignOn
  Tags: 
    - Tag

Properties

Description

The description of the Amazon DataZone domain.

Required: No

Type: String

Update requires: No interruption

DomainExecutionRole

The domain execution role that is created when an Amazon DataZone domain is created. The domain execution role is created in the Amazon account that houses the Amazon DataZone domain.

Required: Yes

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:(role|role/service-role)/[\w+=,.@-]*$

Update requires: No interruption

KmsKeyIdentifier

The identifier of the Amazon Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.

Required: No

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$

Minimum: 1

Maximum: 1024

Update requires: Replacement

Name

The name of the Amazon DataZone domain.

Required: Yes

Type: String

Update requires: No interruption

SingleSignOn

The single sign-on details in Amazon DataZone.

Required: No

Type: SingleSignOn

Update requires: No interruption

Tags

The tags specified for the Amazon DataZone domain.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the Amazon DataZone domain.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the Amazon DataZone domain.

CreatedAt

A timestamp of when a Amazon DataZone domain was created.

Id

The ID of the Amazon DataZone domain.

LastUpdatedAt

A timestamp of when a Amazon DataZone domain was last updated.

ManagedAccountId

The identifier of the Amazon account that manages the domain.

PortalUrl

The data portal URL for the Amazon DataZone domain.

Status

The status of the Amazon DataZone domain.