AWS::DataZone::Environment

DataZone Environment

Definition of AWS::DataZone::Environment Resource Type

Properties

13 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`DomainIdentifier`	`string`	RequiredCreate-onlyWrite-only
`Name`	`string`	Required
`ProjectIdentifier`	`string`	RequiredCreate-onlyWrite-only
`DeploymentOrder`	`integer`	Create-onlyWrite-only
`Description`	`string`
`EnvironmentAccountIdentifier`	`string`	Create-onlyWrite-only
`EnvironmentAccountRegion`	`string`	Create-onlyWrite-only
`EnvironmentBlueprintIdentifier`	`string`	Create-onlyWrite-only
`EnvironmentConfigurationId`	`string`	Create-onlyWrite-only
`EnvironmentProfileIdentifier`	`string`	Create-onlyWrite-only
`EnvironmentRoleArn`	`string`	Write-only
`GlossaryTerms`	`Array<string>`
`UserParameters`	`Array<EnvironmentParameter>`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`AwsAccountId`	`string`	The AWS account in which the Amazon DataZone environment is created.
`AwsAccountRegion`	`string`	The AWS region in which the Amazon DataZone environment is created.
`CreatedAt`	`string`	The timestamp of when the environment was created.
`CreatedBy`	`string`	The Amazon DataZone user who created the environment.
`DomainId`	`string`	The identifier of the Amazon DataZone domain in which the environment is created.
`EnvironmentBlueprintId`	`string`	The ID of the blueprint with which the Amazon DataZone environment was created.
`EnvironmentProfileId`	`string`	The ID of the environment profile with which the Amazon DataZone environment was created.
`Id`	`string`	The ID of the Amazon DataZone environment.
`ProjectId`	`string`	The ID of the Amazon DataZone project in which the environment is created.
`Provider`	`string`	The provider of the Amazon DataZone environment.
`Status`	`string`	The status of the Amazon DataZone environment.
`UpdatedAt`	`string`	The timestamp of when the environment was updated.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DataZone::Environment

Resources:
  MyResource:
    Type: AWS::DataZone::Environment
    Properties:
      Name: "my-name"
      ProjectIdentifier: "my-projectidentifier"
      DomainIdentifier: "my-domainidentifier"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

datazone:CreateEnvironmentdatazone:GetEnvironmentdatazone:DeleteEnvironmentdatazone:AssociateEnvironmentRoleiam:PassRole

read

datazone:GetEnvironment

update

datazone:UpdateEnvironmentdatazone:GetEnvironmentdatazone:DeleteEnvironmentdatazone:AssociateEnvironmentRoledatazone:DisassociateEnvironmentRoleiam:PassRole

delete

datazone:DeleteEnvironmentdatazone:GetEnvironment

list

datazone:ListEnvironments

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceDataZone

Properties25

Required3

TaggingNot supported

Primary IDDomainId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

DomainIdentifierEnvironmentProfileIdentifierProjectIdentifierUserParametersEnvironmentAccountIdentifierEnvironmentAccountRegionEnvironmentBlueprintIdentifierDeploymentOrderEnvironmentConfigurationId

Related Resources

External Links

AWS Documentation