AWS::DataZone::EnvironmentBlueprintConfiguration - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::DataZone::EnvironmentBlueprintConfiguration

The configuration details of an environment blueprint.

Syntax

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

JSON

{
  "Type" : "AWS::DataZone::EnvironmentBlueprintConfiguration",
  "Properties" : {
      "DomainIdentifier" : String,
      "EnabledRegions" : [ String, ... ],
      "EnvironmentBlueprintIdentifier" : String,
      "EnvironmentRolePermissionBoundary" : String,
      "ManageAccessRoleArn" : String,
      "ProvisioningConfigurations" : [ ProvisioningConfiguration, ... ],
      "ProvisioningRoleArn" : String,
      "RegionalParameters" : [ RegionalParameter, ... ]
    }
}

Properties

DomainIdentifier

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

Required: Yes

Type: String

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

Update requires: Replacement

EnabledRegions

The enabled AWS Regions specified in a blueprint configuration.

Required: Yes

Type: Array of String

Maximum: 16

Minimum: 4 | 0

Update requires: No interruption

EnvironmentBlueprintIdentifier

The identifier of the environment blueprint.

In the current release, only the following values are supported: DefaultDataLake and DefaultDataWarehouse.

Required: Yes

Type: String

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

Update requires: Replacement

EnvironmentRolePermissionBoundary

The environment role permission boundary.

Required: No

Type: String

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

Update requires: No interruption

ManageAccessRoleArn

The ARN of the manage access role.

Required: No

Type: String

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

Update requires: No interruption

ProvisioningConfigurations

The provisioning configuration of a blueprint.

Required: No

Type: Array of ProvisioningConfiguration

Update requires: No interruption

ProvisioningRoleArn

The ARN of the provisioning role.

Required: No

Type: String

Pattern: ^arn:aws[^:]*:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)*/[a-zA-Z0-9+=,.@_-]+$

Update requires: No interruption

RegionalParameters

The regional parameters of the environment blueprint.

Required: No

Type: Array of RegionalParameter

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 EnvironmentBlueprintId, which uniquely identifies the environment blueprint configuration. For example: { "Ref": "MyBlueprintConfiguration" } for the resource with the logical ID MyBlueprintConfiguration, Ref returns DomainId|BlueprintConfigurationId.

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 blueprint was created.

DomainId

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

EnvironmentBlueprintId

The identifier of the environment blueprint. This identifier should be used when creating environment profiles.

UpdatedAt

The timestamp of when the environment blueprint was updated.