activities

Creates, updates, deletes or gets an activity resource or lists activities in a region

Overview

Name	activities
Type	Resource
Description	Resource schema for Activity
Id	aws.stepfunctions.activities

Fields

Name	Datatype	Description
arn	string
tags	array
name	string
region	string	AWS region.

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 activities in a region.

SELECT
region,
arn,
tags,
name
FROM aws.stepfunctions.activities
WHERE region = 'us-east-1';

Gets all properties from an individual activity.

SELECT
region,
arn,
tags,
name
FROM aws.stepfunctions.activities
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.stepfunctions.activities (
 Tags,
 Name,
 region
)
SELECT 
 '{{ Tags }}',
 '{{ Name }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: activity
    props:
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'
      - name: Name
        value: '{{ Name }}'

DELETE example

/*+ delete */
DELETE FROM aws.stepfunctions.activities
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Read

states:DescribeActivity,
states:ListTagsForResource

Create

states:CreateActivity,
states:TagResource

Update

states:ListTagsForResource,
states:TagResource,
states:UntagResource

List

states:ListActivities

Delete

states:DescribeActivity,
states:DeleteActivity