environment_actions

Creates, updates, deletes or gets an environment_action resource or lists environment_actions in a region

Overview

Name	environment_actions
Type	Resource
Description	Definition of AWS::DataZone::EnvironmentActions Resource Type
Id	aws.datazone.environment_actions

Fields

Name	Datatype	Description
description	string	The description of the Amazon DataZone environment action.
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_id	string	The identifier of the Amazon DataZone environment in which the action is taking place
environment_identifier	string	The identifier of the Amazon DataZone environment in which the action is taking place
id	string	The ID of the Amazon DataZone environment action.
identifier	string	The ID of the Amazon DataZone environment action.
name	string	The name of the environment action.
parameters	object	The parameters of the environment action.
region	string	AWS region.

For more information, see AWS::DataZone::EnvironmentActions.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, 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 environment_actions in a region.

SELECT
region,
description,
domain_id,
domain_identifier,
environment_id,
environment_identifier,
id,
identifier,
name,
parameters
FROM aws.datazone.environment_actions
WHERE region = 'us-east-1';

Gets all properties from an individual environment_action.

SELECT
region,
description,
domain_id,
domain_identifier,
environment_id,
environment_identifier,
id,
identifier,
name,
parameters
FROM aws.datazone.environment_actions
WHERE region = 'us-east-1' AND data__Identifier = '<DomainId>|<EnvironmentId>|<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.datazone.environment_actions (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.datazone.environment_actions (
 Description,
 DomainIdentifier,
 EnvironmentIdentifier,
 Identifier,
 Name,
 Parameters,
 region
)
SELECT 
 '{{ Description }}',
 '{{ DomainIdentifier }}',
 '{{ EnvironmentIdentifier }}',
 '{{ Identifier }}',
 '{{ Name }}',
 '{{ Parameters }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: environment_action
    props:
      - name: Description
        value: '{{ Description }}'
      - name: DomainIdentifier
        value: '{{ DomainIdentifier }}'
      - name: EnvironmentIdentifier
        value: '{{ EnvironmentIdentifier }}'
      - name: Identifier
        value: '{{ Identifier }}'
      - name: Name
        value: '{{ Name }}'
      - name: Parameters
        value:
          Uri: '{{ Uri }}'

DELETE example

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

Permissions

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

Create

datazone:CreateEnvironmentAction,
datazone:GetEnvironmentAction,
datazone:DeleteEnvironmentAction

Read

datazone:GetEnvironmentAction

Update

datazone:UpdateEnvironmentAction,
datazone:GetEnvironmentAction,
datazone:DeleteEnvironmentAction

Delete

datazone:DeleteEnvironmentAction,
datazone:GetEnvironmentAction

List

datazone:ListEnvironmentActions