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	awscc.stepfunctions.activities

Fields

get (all properties)

Name	Datatype	Description
arn	string
name	string
▶tags	array
▶encryption_configuration	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual activity.

SELECT
  region,
  arn,
  name,
  tags,
  encryption_configuration
FROM awscc.stepfunctions.activities
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all activities in a region.

SELECT
  region,
  arn
FROM awscc.stepfunctions.activities_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.stepfunctions.activities (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.stepfunctions.activities (
  Name,
  Tags,
  EncryptionConfiguration,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ encryption_configuration }}',
  '{{ 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: activity
  props:
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: encryption_configuration
      value:
        kms_key_id: '{{ kms_key_id }}'
        kms_data_key_reuse_period_seconds: '{{ kms_data_key_reuse_period_seconds }}'
        type: '{{ type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.stepfunctions.activities
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.stepfunctions.activities
WHERE
  Identifier = '{{ arn }}' 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 activities resource, the following permissions are required:

Create

states:CreateActivity,
states:DescribeActivity,
states:TagResource,
kms:DescribeKey

Read

states:DescribeActivity,
states:ListTagsForResource

Update

states:ListTagsForResource,
states:TagResource,
states:UntagResource

Delete

states:DescribeActivity,
states:DeleteActivity

List

states:ListActivities