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	awscc.datazone.environment_actions

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
domain_id	string	The identifier of the Amazon DataZone domain in which the environment is created.
environment_id	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.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	environment_actions	INSERT	Name, region
delete_resource	environment_actions	DELETE	Identifier, region
update_resource	environment_actions	UPDATE	Identifier, PatchDocument, region
list_resources	environment_actions_list_only	SELECT	region
get_resource	environment_actions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual environment_action.

SELECT
  region,
  description,
  domain_id,
  domain_identifier,
  environment_id,
  environment_identifier,
  id,
  identifier,
  name,
  parameters
FROM awscc.datazone.environment_actions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ environment_id }}|{{ id }}';

list (identifiers only)

Lists all environment_actions in a region.

SELECT
  region,
  domain_id,
  environment_id,
  id
FROM awscc.datazone.environment_actions_list_only
WHERE
  region = '{{ region }}';

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 awscc.datazone.environment_actions (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datazone.environment_actions (
  Description,
  DomainIdentifier,
  EnvironmentIdentifier,
  Identifier,
  Name,
  Parameters,
  region
)
SELECT
  '{{ description }}',
  '{{ domain_identifier }}',
  '{{ environment_identifier }}',
  '{{ identifier }}',
  '{{ name }}',
  '{{ parameters }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: domain_identifier
      value: '{{ domain_identifier }}'
    - name: environment_identifier
      value: '{{ environment_identifier }}'
    - name: identifier
      value: '{{ identifier }}'
    - name: name
      value: '{{ name }}'
    - name: parameters
      value:
        uri: '{{ uri }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datazone.environment_actions
SET PatchDocument = string('{{ {
    "Description": description,
    "Identifier": identifier,
    "Name": name,
    "Parameters": parameters
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_id }}|{{ environment_id }}|{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.datazone.environment_actions
WHERE
  Identifier = '{{ domain_id }}|{{ environment_id }}|{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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