AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::StepFunctions::Activity

CfnActivity

An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions . Activities must poll Step Functions using the `GetActivityTask` API action and respond using `SendTask*` API actions. This function makes Step Functions aware of your activity and returns an identifier for use in a state machine and when polling from the activity. For information about creating an activity, see [Creating an Activity State Machine](https://docs.aws.amazon.com/step-functions/latest/dg/tutorial-creating-activity-state-machine.html) in the *AWS Step Functions Developer Guide* and [CreateActivity](https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateActivity.html) in the *AWS Step Functions API Reference* .

Import

import { CfnActivity } from 'aws-cdk-lib/aws-stepfunctions';

Or use the module namespace:

import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
// stepfunctions.CfnActivity

Properties

Configuration passed to the constructor as CfnActivityProps.

nameRequired
string

The name of the activity. A name must *not* contain: - white space - brackets `< > { } [ ]` - wildcard characters `? *` - special characters `" # % \ ^ | ~ ` $ & , ; : /` - control characters ( `U+0000-001F` , `U+007F-009F` , `U+FFFE-FFFF` ) - surrogates ( `U+D800-DFFF` ) - invalid characters ( `U+10FFFF` ) To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

encryptionConfigurationOptional
IResolvable | EncryptionConfigurationProperty

Encryption configuration for the activity. Activity configuration is immutable, and resource names must be unique. To set customer managed keys for encryption, you must create a *new Activity* . If you attempt to change the configuration in your CFN template for an existing activity, you will receive an `ActivityAlreadyExists` exception. To update your activity to include customer managed keys, set a new activity name within your CloudFormation template.

tagsOptional
TagsEntryProperty[]

The list of tags to add to a resource. Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the AWS Step Functions Cheat Sheet

Everything you need to know about AWS Step Functions on one page. HD quality, print-friendly.

Download Free Infographic