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
name	string
tags	array
encryption_configuration	object
region	string	AWS region.

For more information, see AWS::StepFunctions::Activity.

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,
name,
tags,
encryption_configuration
FROM aws.stepfunctions.activities
WHERE region = 'us-east-1';

Gets all properties from an individual activity.

SELECT
region,
arn,
name,
tags,
encryption_configuration
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 (
 Name,
 Tags,
 EncryptionConfiguration,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Tags }}',
 '{{ EncryptionConfiguration }}',
 '{{ region }}';

Manifest

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

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:

Create

states:CreateActivity,
states:TagResource,
kms:DescribeKey

Read

states:DescribeActivity,
states:ListTagsForResource

Update

states:ListTagsForResource,
states:TagResource,
states:UntagResource

Delete

states:DescribeActivity,
states:DeleteActivity

List

states:ListActivities