AWS::DataZone::EnvironmentProfile

The details of an environment profile.

Syntax

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

JSON

{
  "Type" : "AWS::DataZone::EnvironmentProfile",
  "Properties" : {
      "AwsAccountId" : String,
      "AwsAccountRegion" : String,
      "Description" : String,
      "DomainIdentifier" : String,
      "EnvironmentBlueprintIdentifier" : String,
      "Name" : String,
      "ProjectIdentifier" : String,
      "UserParameters" : [ EnvironmentParameter, ... ]
    }
}

YAML

Type: AWS::DataZone::EnvironmentProfile
Properties:
  AwsAccountId: String
  AwsAccountRegion: String
  Description: String
  DomainIdentifier: String
  EnvironmentBlueprintIdentifier: String
  Name: String
  ProjectIdentifier: String
  UserParameters: 
    - EnvironmentParameter

Properties

AwsAccountId

The identifier of an AWS account in which an environment profile exists.

Required: Yes

Type: String

Pattern: ^\d{12}$

Update requires: No interruption

AwsAccountRegion

The AWS Region in which an environment profile exists.

Required: Yes

Type: String

Pattern: ^[a-z]{2}-[a-z]{4,10}-\d$

Update requires: No interruption

Description

The description of the environment profile.

Required: No

Type: String

Maximum: 2048

Update requires: No interruption

DomainIdentifier

The identifier of the Amazon DataZone domain in which the environment profile exists.

Required: Yes

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

EnvironmentBlueprintIdentifier

The identifier of a blueprint with which an environment profile is created.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

Name

The name of the environment profile.

Required: Yes

Type: String

Pattern: ^[\w -]+$

Minimum: 1

Maximum: 64

Update requires: No interruption

ProjectIdentifier

The identifier of a project in which an environment profile exists.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Update requires: Replacement

UserParameters

The user parameters of this Amazon DataZone environment profile.

Required: No

Type: Array of EnvironmentParameter

Update requires: No interruption

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 the EnvironmentProfileId, which uniquely identifies the environment profile. For example: { "Ref": "MyEnvironmentProfile" } for the resource with the logical ID MyEnvironmentProfile, Ref returns DomainId|EnvironmentProfileId.

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.

CreatedAt

The timestamp of when an environment profile was created.

CreatedBy

The Amazon DataZone user who created the environment profile.

DomainId

The identifier of the Amazon DataZone domain in which the environment profile exists.

EnvironmentBlueprintId

The identifier of a blueprint with which an environment profile is created.

Id

The identifier of the environment profile.

ProjectId

The identifier of a project in which an environment profile exists.

UpdatedAt

The timestamp of when the environment profile was updated.