environment_blueprint_configurations

Creates, updates, deletes, gets or lists an environment_blueprint_configurations resource.

Overview

Name	environment_blueprint_configurations
Type	Resource
Id	aws.datazone.environment_blueprint_configurations

Fields

The following fields are returned by SELECT queries:

get_environment_blueprint_configuration

Name	Datatype	Description
allow_user_provided_configurations	boolean	Specifies whether user-provided resource configurations are allowed for the environment blueprint.
created_at	string (date-time)	The timestamp of when this blueprint was created.
domain_id	string	The ID of the Amazon DataZone domain where this blueprint exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
enabled_regions	array	The Amazon Web Services regions in which this blueprint is enabled.
environment_blueprint_id	string	The ID of the blueprint. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
environment_role_permission_boundary	string	The environment role permissions boundary. (pattern: <code>arn:aws[^:]:iam::(aws|\d{12}):policy/[\w+=,.@-]</code>)
manage_access_role_arn	string	The ARN of the manage access role with which this blueprint is created. (pattern: <code>arn:aws[^:]:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)/[a-zA-Z0-9+=,.@_-]+</code>)
provisioning_configurations	array	The provisioning configuration of a blueprint.
provisioning_role_arn	string	The ARN of the provisioning role with which this blueprint is created. (pattern: <code>arn:aws[^:]:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)/[a-zA-Z0-9+=,.@_-]+</code>)
regional_parameters	object	The regional parameters of the blueprint.
resource_configurations	array	The resource configurations of the environment blueprint.
updated_at	string (date-time)	The timestamp of when this blueprint was upated.

list_environment_blueprint_configurations

Name	Datatype	Description
allow_user_provided_configurations	boolean	Specifies whether user-provided resource configurations are allowed for the environment blueprint.
created_at	string (date-time)	The timestamp of when an environment blueprint was created.
domain_id	string	The identifier of the Amazon DataZone domain in which an environment blueprint exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
enabled_regions	array	The enabled Amazon Web Services Regions specified in a blueprint configuration.
environment_blueprint_id	string	The identifier of the environment blueprint. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
environment_role_permission_boundary	string	The environment role permission boundary. (pattern: <code>arn:aws[^:]:iam::(aws|\d{12}):policy/[\w+=,.@-]</code>)
manage_access_role_arn	string	The ARN of the manage access role specified in the environment blueprint configuration. (pattern: <code>arn:aws[^:]:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)/[a-zA-Z0-9+=,.@_-]+</code>)
provisioning_configurations	array	The provisioning configuration of a blueprint.
provisioning_role_arn	string	The ARN of the provisioning role specified in the environment blueprint configuration. (pattern: <code>arn:aws[^:]:iam::\d{12}:role(/[a-zA-Z0-9+=,.@_-]+)/[a-zA-Z0-9+=,.@_-]+</code>)
regional_parameters	object	The regional parameters of the environment blueprint.
resource_configurations	array	The resource configurations of the environment blueprint.
updated_at	string (date-time)	The timestamp of when the environment blueprint was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_environment_blueprint_configuration	select	domain_identifier, environment_blueprint_identifier, region		Gets the blueprint configuration in Amazon DataZone.
list_environment_blueprint_configurations	select	domain_identifier, region	maxResults, nextToken	Lists blueprint configurations for a Amazon DataZone environment.
put_environment_blueprint_configuration	replace	domain_identifier, environment_blueprint_identifier, region, enabledRegions		Writes the configuration for the specified environment blueprint in Amazon DataZone.
delete_environment_blueprint_configuration	delete	domain_identifier, environment_blueprint_identifier, region		Deletes the blueprint configuration in Amazon DataZone.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
domain_identifier	string	The ID of the Amazon DataZone domain in which the blueprint configuration is deleted.
environment_blueprint_identifier	string	The ID of the blueprint the configuration of which is deleted.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of blueprint configurations to return in a single call to ListEnvironmentBlueprintConfigurations. When the number of configurations to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.
nextToken	string	When the number of blueprint configurations is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of configurations, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintConfigurations to list the next set of configurations.

SELECT examples

get_environment_blueprint_configuration

Gets the blueprint configuration in Amazon DataZone.

SELECT
allow_user_provided_configurations,
created_at,
domain_id,
enabled_regions,
environment_blueprint_id,
environment_role_permission_boundary,
manage_access_role_arn,
provisioning_configurations,
provisioning_role_arn,
regional_parameters,
resource_configurations,
updated_at
FROM aws.datazone.environment_blueprint_configurations
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND environment_blueprint_identifier = '{{ environment_blueprint_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_environment_blueprint_configurations

Lists blueprint configurations for a Amazon DataZone environment.

SELECT
allow_user_provided_configurations,
created_at,
domain_id,
enabled_regions,
environment_blueprint_id,
environment_role_permission_boundary,
manage_access_role_arn,
provisioning_configurations,
provisioning_role_arn,
regional_parameters,
resource_configurations,
updated_at
FROM aws.datazone.environment_blueprint_configurations
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

REPLACE examples

put_environment_blueprint_configuration

Writes the configuration for the specified environment blueprint in Amazon DataZone.

REPLACE aws.datazone.environment_blueprint_configurations
SET 
provisioningRoleArn = '{{ provisioningRoleArn }}',
manageAccessRoleArn = '{{ manageAccessRoleArn }}',
environmentRolePermissionBoundary = '{{ environmentRolePermissionBoundary }}',
enabledRegions = '{{ enabledRegions }}',
regionalParameters = '{{ regionalParameters }}',
resourceConfigurations = '{{ resourceConfigurations }}',
allowUserProvidedConfigurations = {{ allowUserProvidedConfigurations }},
globalParameters = '{{ globalParameters }}',
provisioningConfigurations = '{{ provisioningConfigurations }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND environment_blueprint_identifier = '{{ environment_blueprint_identifier }}' --required
AND region = '{{ region }}' --required
AND enabledRegions = '{{ enabledRegions }}' --required
RETURNING
allow_user_provided_configurations,
created_at,
domain_id,
enabled_regions,
environment_blueprint_id,
environment_role_permission_boundary,
manage_access_role_arn,
provisioning_configurations,
provisioning_role_arn,
regional_parameters,
resource_configurations,
updated_at;

DELETE examples

delete_environment_blueprint_configuration

Deletes the blueprint configuration in Amazon DataZone.

DELETE FROM aws.datazone.environment_blueprint_configurations
WHERE domain_identifier = '{{ domain_identifier }}' --required
AND environment_blueprint_identifier = '{{ environment_blueprint_identifier }}' --required
AND region = '{{ region }}' --required
;