environment_blueprints

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

Overview

Name	environment_blueprints
Type	Resource
Id	aws.datazone.environment_blueprints

Fields

The following fields are returned by SELECT queries:

get_environment_blueprint

Name	Datatype	Description
id	string	The ID of this Amazon DataZone blueprint. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of this Amazon DataZone blueprint. (pattern: <code>[\w -]+</code>)
created_at	string (date-time)	A timestamp of when this blueprint was created.
deployment_properties	object	The deployment properties of this Amazon DataZone blueprint.
description	string	The description of this Amazon DataZone blueprint.
glossary_terms	array	The glossary terms attached to this Amazon DataZone blueprint.
provider	string	The provider of this Amazon DataZone blueprint.
provisioning_properties	object	The provisioning properties of an environment blueprint.
updated_at	string (date-time)	The timestamp of when this blueprint was updated.
user_parameters	array	The user parameters of this blueprint.

list_environment_blueprints

Name	Datatype	Description
id	string	The identifier of the blueprint. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
name	string	The name of the blueprint. (pattern: <code>[\w -]+</code>)
created_at	string (date-time)	The timestamp of when an environment blueprint was created.
description	string	The description of a blueprint.
provider	string	The provider of the blueprint.
provisioning_properties	object	The provisioning properties of an environment blueprint.
updated_at	string (date-time)	The timestamp of when the blueprint was enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_environment_blueprint	select	domain_identifier, identifier, region		Gets an Amazon DataZone blueprint.
list_environment_blueprints	select	domain_identifier, region	maxResults, nextToken, name, managed	Lists blueprints in an Amazon DataZone environment.
create_environment_blueprint	insert	domain_identifier, region, name, provisioningProperties		Creates a Amazon DataZone blueprint.
update_environment_blueprint	update	domain_identifier, identifier, region		Updates an environment blueprint in Amazon DataZone.
delete_environment_blueprint	delete	domain_identifier, identifier, region		Deletes a blueprint 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 is deleted.
identifier	string	The ID of the blueprint that is deleted.
region	string	AWS region (default: us-east-1)
managed	boolean	Specifies whether the environment blueprint is managed by Amazon DataZone.
maxResults	integer	The maximum number of blueprints to return in a single call to ListEnvironmentBlueprints. When the number of blueprints 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 ListEnvironmentBlueprints to list the next set of blueprints.
name	string	The name of the Amazon DataZone environment.
nextToken	string	When the number of blueprints in the environment 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 blueprints in the environment, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentBlueprintsto list the next set of blueprints.

SELECT examples

get_environment_blueprint

Gets an Amazon DataZone blueprint.

SELECT
id,
name,
created_at,
deployment_properties,
description,
glossary_terms,
provider,
provisioning_properties,
updated_at,
user_parameters
FROM aws.datazone.environment_blueprints
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_environment_blueprints

Lists blueprints in an Amazon DataZone environment.

SELECT
id,
name,
created_at,
description,
provider,
provisioning_properties,
updated_at
FROM aws.datazone.environment_blueprints
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND name = '{{ name }}'
AND managed = '{{ managed }}'
;

INSERT examples

create_environment_blueprint

Creates a Amazon DataZone blueprint.

INSERT INTO aws.datazone.environment_blueprints (
name,
description,
provisioningProperties,
userParameters,
domain_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ provisioningProperties }}' /* required */,
'{{ userParameters }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
name,
created_at,
deployment_properties,
description,
glossary_terms,
provider,
provisioning_properties,
updated_at,
user_parameters
;

Manifest

# Description fields are for documentation purposes
- name: environment_blueprints
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the environment_blueprints resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environment_blueprints resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: provisioningProperties
    description: |
      The provisioning properties of an environment blueprint.
    value:
      cloudFormation:
        templateUrl: "{{ templateUrl }}"
  - name: userParameters
    value:
      - keyName: "{{ keyName }}"
        description: "{{ description }}"
        fieldType: "{{ fieldType }}"
        defaultValue: "{{ defaultValue }}"
        isEditable: {{ isEditable }}
        isOptional: {{ isOptional }}
        isUpdateSupported: {{ isUpdateSupported }}

UPDATE examples

update_environment_blueprint

Updates an environment blueprint in Amazon DataZone.

UPDATE aws.datazone.environment_blueprints
SET 
description = '{{ description }}',
provisioningProperties = '{{ provisioningProperties }}',
userParameters = '{{ userParameters }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
created_at,
deployment_properties,
description,
glossary_terms,
provider,
provisioning_properties,
updated_at,
user_parameters;

DELETE examples

delete_environment_blueprint

Deletes a blueprint in Amazon DataZone.

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