The AWS::DataZone::Environmentresource specifies an Amazon DataZone
environment, which is a collection of zero or more configured resources with a given set of
IAM principals who can operate on those resources.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::DataZone::Environment",
"Properties" : {
"Description" : String,
"DomainIdentifier" : String,
"EnvironmentAccountIdentifier" : String,
"EnvironmentAccountRegion" : String,
"EnvironmentProfileIdentifier" : String,
"EnvironmentRoleArn" : String,
"GlossaryTerms" : [ String, ... ],
"Name" : String,
"ProjectIdentifier" : String,
"UserParameters" : [ EnvironmentParameter, ... ]
}
}
YAML
Type: AWS::DataZone::Environment
Properties:
Description: String
DomainIdentifier: String
EnvironmentAccountIdentifier: String
EnvironmentAccountRegion: String
EnvironmentProfileIdentifier: String
EnvironmentRoleArn: String
GlossaryTerms:
- String
Name: String
ProjectIdentifier: String
UserParameters:
- EnvironmentParameter
Properties
Description-
The description of the environment.
Required: No
Type: String
Maximum:
2048Update requires: No interruption
DomainIdentifier-
The identifier of the Amazon DataZone domain in which the environment is created.
Required: Yes
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Update requires: Replacement
EnvironmentAccountIdentifier-
The identifier of the AWS account in which an environment exists.
Required: No
Type: String
Pattern:
^\d{12}$Update requires: Replacement
EnvironmentAccountRegion-
The AWS Region in which an environment exists.
Required: No
Type: String
Pattern:
^[a-z]{2}-[a-z]{4,10}-\d$Update requires: Replacement
EnvironmentProfileIdentifier-
The identifier of the environment profile that is used to create this Amazon DataZone environment.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9_-]{0,36}$Update requires: Replacement
EnvironmentRoleArn-
The ARN of the environment role.
Required: No
Type: String
Update requires: No interruption
GlossaryTerms-
The glossary terms that can be used in this Amazon DataZone environment.
Required: No
Type: Array of String
Minimum:
1Maximum:
20Update requires: No interruption
Name-
The name of the Amazon DataZone environment.
Required: Yes
Type: String
Pattern:
^[\w -]+$Minimum:
1Maximum:
64Update requires: No interruption
ProjectIdentifier-
The identifier of the Amazon DataZone project in which this environment is created.
Required: Yes
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$Update requires: Replacement
UserParameters-
The user parameters of this Amazon DataZone environment.
Required: No
Type: Array of EnvironmentParameter
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a string containing pipe-separated DomainId and
EnvironmentId, which uniquely identifies the environment. For example:
{ "Ref": "MyEnvironment" } for the resource with the logical ID
MyEnvironment, Ref returns
DomainId|EnvironmentId.
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.
AwsAccountId-
The identifier of the AWS account in which an environment exists.
AwsAccountRegion-
The AWS Region in which an environment exists.
CreatedAt-
The timestamp of when the environment was created.
CreatedBy-
The Amazon DataZone user who created the environment.
DomainId-
The identifier of the Amazon DataZone domain in which the environment exists.
EnvironmentBlueprintId-
The identifier of a blueprint with which an environment profile is created.
EnvironmentProfileId-
The identifier of the environment profile with which the environment was created.
Id-
The identifier of the environment.
ProjectId-
The identifier of the project in which the environment exists.
Provider-
The provider of the environment.
Status-
The status of the environment.
UpdatedAt-
The timestamp of when the environment was updated.
