environment_profiles

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

Overview

Name	environment_profiles
Type	Resource
Id	aws.datazone.environment_profiles

Fields

The following fields are returned by SELECT queries:

get_environment_profile

Name	Datatype	Description
id	string	The ID of the environment profile. (pattern: <code>[a-zA-Z0-9_-]{0,36}</code>)
name	string	The name of the environment profile. (pattern: <code>[\w -]+</code>)
aws_account_id	string	The ID of the Amazon Web Services account where this environment profile exists. (pattern: <code>\d{12}</code>)
aws_account_region	string	The Amazon Web Services region where this environment profile exists. (pattern: <code>[a-z]{2}-[a-z]{4,10}-\d</code>)
created_at	string (date-time)	The timestamp of when this environment profile was created.
created_by	string	The Amazon DataZone user who created this environment profile.
description	string	The description of the environment profile.
domain_id	string	The ID of the Amazon DataZone domain in which this environment profile exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
environment_blueprint_id	string	The ID of the blueprint with which this environment profile is created. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
project_id	string	The ID of the Amazon DataZone project in which this environment profile is created. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
updated_at	string (date-time)	The timestamp of when this environment profile was upated.
user_parameters	array	The user parameters of the environment profile.

list_environment_profiles

Name	Datatype	Description
id	string	The identifier of the environment profile. (pattern: <code>[a-zA-Z0-9_-]{0,36}</code>)
name	string	The name of the environment profile. (pattern: <code>[\w -]+</code>)
aws_account_id	string	The identifier of an Amazon Web Services account in which an environment profile exists. (pattern: <code>\d{12}</code>)
aws_account_region	string	The Amazon Web Services Region in which an environment profile exists. (pattern: <code>[a-z]{2}-[a-z]{4,10}-\d</code>)
created_at	string (date-time)	The timestamp of when an environment profile was created.
created_by	string	The Amazon DataZone user who created the environment profile.
description	string	The description of the environment profile.
domain_id	string	The identifier of the Amazon DataZone domain in which the environment profile exists. (pattern: <code>dzd[-][a-zA-Z0-9-]{1,36}</code>)
environment_blueprint_id	string	The identifier of a blueprint with which an environment profile is created. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
project_id	string	The identifier of a project in which an environment profile exists. (pattern: <code>[a-zA-Z0-9_-]{1,36}</code>)
updated_at	string (date-time)	The timestamp of when the environment profile was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_environment_profile	select	domain_identifier, identifier, region		Gets an evinronment profile in Amazon DataZone.
list_environment_profiles	select	domain_identifier, region	awsAccountId, awsAccountRegion, environmentBlueprintIdentifier, projectIdentifier, name, nextToken, maxResults	Lists Amazon DataZone environment profiles.
create_environment_profile	insert	domain_identifier, region, name, environmentBlueprintIdentifier, projectIdentifier		Creates an Amazon DataZone environment profile.
update_environment_profile	update	domain_identifier, identifier, region		Updates the specified environment profile in Amazon DataZone.
delete_environment_profile	delete	domain_identifier, identifier, region		Deletes an environment profile 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 environment profile is deleted.
identifier	string	The ID of the environment profile that is deleted.
region	string	AWS region (default: us-east-1)
awsAccountId	string	The identifier of the Amazon Web Services account where you want to list environment profiles.
awsAccountRegion	string	The Amazon Web Services region where you want to list environment profiles.
environmentBlueprintIdentifier	string	The identifier of the blueprint that was used to create the environment profiles that you want to list.
maxResults	integer	The maximum number of environment profiles to return in a single call to ListEnvironmentProfiles. When the number of environment profiles 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 ListEnvironmentProfiles to list the next set of environment profiles.
name	string
nextToken	string	When the number of environment profiles 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 environment profiles, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironmentProfiles to list the next set of environment profiles.
projectIdentifier	string	The identifier of the Amazon DataZone project.

SELECT examples

get_environment_profile

Gets an evinronment profile in Amazon DataZone.

SELECT
id,
name,
aws_account_id,
aws_account_region,
created_at,
created_by,
description,
domain_id,
environment_blueprint_id,
project_id,
updated_at,
user_parameters
FROM aws.datazone.environment_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_environment_profiles

Lists Amazon DataZone environment profiles.

SELECT
id,
name,
aws_account_id,
aws_account_region,
created_at,
created_by,
description,
domain_id,
environment_blueprint_id,
project_id,
updated_at
FROM aws.datazone.environment_profiles
WHERE domain_identifier = '{{ domain_identifier }}' -- required
AND region = '{{ region }}' -- required
AND awsAccountId = '{{ awsAccountId }}'
AND awsAccountRegion = '{{ awsAccountRegion }}'
AND environmentBlueprintIdentifier = '{{ environmentBlueprintIdentifier }}'
AND projectIdentifier = '{{ projectIdentifier }}'
AND name = '{{ name }}'
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_environment_profile

Creates an Amazon DataZone environment profile.

INSERT INTO aws.datazone.environment_profiles (
name,
description,
environmentBlueprintIdentifier,
projectIdentifier,
userParameters,
awsAccountId,
awsAccountRegion,
domain_identifier,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ environmentBlueprintIdentifier }}' /* required */,
'{{ projectIdentifier }}' /* required */,
'{{ userParameters }}',
'{{ awsAccountId }}',
'{{ awsAccountRegion }}',
'{{ domain_identifier }}',
'{{ region }}'
RETURNING
id,
name,
aws_account_id,
aws_account_region,
created_at,
created_by,
description,
domain_id,
environment_blueprint_id,
project_id,
updated_at,
user_parameters
;

Manifest

# Description fields are for documentation purposes
- name: environment_profiles
props:
  - name: domain_identifier
    value: "{{ domain_identifier }}"
    description: Required parameter for the environment_profiles resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the environment_profiles resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: environmentBlueprintIdentifier
    value: "{{ environmentBlueprintIdentifier }}"
  - name: projectIdentifier
    value: "{{ projectIdentifier }}"
  - name: userParameters
    value:
      - name: "{{ name }}"
        value: "{{ value }}"
  - name: awsAccountId
    value: "{{ awsAccountId }}"
  - name: awsAccountRegion
    value: "{{ awsAccountRegion }}"

UPDATE examples

update_environment_profile

Updates the specified environment profile in Amazon DataZone.

UPDATE aws.datazone.environment_profiles
SET 
name = '{{ name }}',
description = '{{ description }}',
userParameters = '{{ userParameters }}',
awsAccountId = '{{ awsAccountId }}',
awsAccountRegion = '{{ awsAccountRegion }}'
WHERE 
domain_identifier = '{{ domain_identifier }}' --required
AND identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
id,
name,
aws_account_id,
aws_account_region,
created_at,
created_by,
description,
domain_id,
environment_blueprint_id,
project_id,
updated_at,
user_parameters;

DELETE examples

delete_environment_profile

Deletes an environment profile in Amazon DataZone.

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