environments

Creates, updates, deletes or gets an environment resource or lists environments in a region

Overview

Name	environments
Type	Resource
Description	Definition of AWS::DataZone::Environment Resource Type
Id	aws.datazone.environments

Fields

Name	Datatype	Description
aws_account_id	string	The AWS account in which the Amazon DataZone environment is created.
aws_account_region	string	The AWS region in which the Amazon DataZone environment is created.
created_at	string	The timestamp of when the environment was created.
created_by	string	The Amazon DataZone user who created the environment.
description	string	The description of the Amazon DataZone environment.
domain_id	string	The identifier of the Amazon DataZone domain in which the environment is created.
domain_identifier	string	The identifier of the Amazon DataZone domain in which the environment would be created.
environment_blueprint_id	string	The ID of the blueprint with which the Amazon DataZone environment was created.
environment_profile_id	string	The ID of the environment profile with which the Amazon DataZone environment was created.
environment_profile_identifier	string	The ID of the environment profile with which the Amazon DataZone environment would be created.
glossary_terms	array	The glossary terms that can be used in the Amazon DataZone environment.
id	string	The ID of the Amazon DataZone environment.
name	string	The name of the environment.
project_id	string	The ID of the Amazon DataZone project in which the environment is created.
project_identifier	string	The ID of the Amazon DataZone project in which the environment would be created.
provider	string	The provider of the Amazon DataZone environment.
status	string	The status of the Amazon DataZone environment.
updated_at	string	The timestamp of when the environment was updated.
user_parameters	array	The user parameters of the Amazon DataZone environment.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EnvironmentProfileIdentifier, Name, ProjectIdentifier, DomainIdentifier, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all environments in a region.

SELECT
region,
aws_account_id,
aws_account_region,
created_at,
created_by,
description,
domain_id,
domain_identifier,
environment_blueprint_id,
environment_profile_id,
environment_profile_identifier,
glossary_terms,
id,
name,
project_id,
project_identifier,
provider,
status,
updated_at,
user_parameters
FROM aws.datazone.environments
WHERE region = 'us-east-1';

Gets all properties from an individual environment.

SELECT
region,
aws_account_id,
aws_account_region,
created_at,
created_by,
description,
domain_id,
domain_identifier,
environment_blueprint_id,
environment_profile_id,
environment_profile_identifier,
glossary_terms,
id,
name,
project_id,
project_identifier,
provider,
status,
updated_at,
user_parameters
FROM aws.datazone.environments
WHERE region = 'us-east-1' AND data__Identifier = '<DomainId>|<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new environment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.datazone.environments (
 DomainIdentifier,
 EnvironmentProfileIdentifier,
 Name,
 ProjectIdentifier,
 region
)
SELECT 
'{{ DomainIdentifier }}',
 '{{ EnvironmentProfileIdentifier }}',
 '{{ Name }}',
 '{{ ProjectIdentifier }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.datazone.environments (
 Description,
 DomainIdentifier,
 EnvironmentProfileIdentifier,
 GlossaryTerms,
 Name,
 ProjectIdentifier,
 UserParameters,
 region
)
SELECT 
 '{{ Description }}',
 '{{ DomainIdentifier }}',
 '{{ EnvironmentProfileIdentifier }}',
 '{{ GlossaryTerms }}',
 '{{ Name }}',
 '{{ ProjectIdentifier }}',
 '{{ UserParameters }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: environment
    props:
      - name: Description
        value: '{{ Description }}'
      - name: DomainIdentifier
        value: '{{ DomainIdentifier }}'
      - name: EnvironmentProfileIdentifier
        value: '{{ EnvironmentProfileIdentifier }}'
      - name: GlossaryTerms
        value:
          - '{{ GlossaryTerms[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: ProjectIdentifier
        value: '{{ ProjectIdentifier }}'
      - name: UserParameters
        value:
          - Name: '{{ Name }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.datazone.environments
WHERE data__Identifier = '<DomainId|Id>'
AND region = 'us-east-1';

Permissions

To operate on the environments resource, the following permissions are required:

Create

datazone:CreateEnvironment,
datazone:GetEnvironment,
datazone:DeleteEnvironment

Read

datazone:GetEnvironment

Update

datazone:UpdateEnvironment,
datazone:GetEnvironment,
datazone:DeleteEnvironment

Delete

datazone:DeleteEnvironment,
datazone:GetEnvironment

List

datazone:ListEnvironments