AWS::StepFunctions::Activity
An activity is a task that you write in any programming language and host on any machine
that has access to Amazon Step Functions. Activities must poll Step Functions using the
GetActivityTask
API action and respond using SendTask*
API
actions. This function lets Step Functions know the existence 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 in the Amazon Step Functions Developer Guide and CreateActivity in the Amazon Step Functions API Reference.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::StepFunctions::Activity", "Properties" : { "Name" :
String
, "Tags" :[ TagsEntry, ... ]
} }
Properties
Name
-
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
)
To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
Required: Yes
Type: String
Minimum:
1
Maximum:
80
Update requires: Replacement
-
-
The list of tags to add to a resource.
Tags may only contain Unicode letters, digits, white space, or these symbols:
_ . : / = + - @
.Required: No
Type: Array of TagsEntry
Update requires: No interruption
Return values
Ref
When you provide the logical ID of this resource to the Ref
intrinsic
function, Ref
returns the ARN of the created activity. For example:
{ "Ref": "MyActivity" }
Returns a value similar to the following:
arn:aws:states:us-east-1:111122223333:activity:myActivity
For more information about using the Ref
function, see Ref.
Fn::GetAtt
Fn::GetAtt
returns a value for a specified attribute of this type. The
following are the available attributes and sample return values.
Arn
-
Returns the ARN of the resource.
Name
-
Returns the name of the activity. For example:
{ "Fn::GetAtt": ["MyActivity", "Name"] }
Returns a value similar to the following:
myActivity
For more information about using
Fn::GetAtt
, see Fn::GetAtt.
Examples
The following examples create a Step Functions activity.
JSON
{ "AWSTemplateFormatVersion" : "2010-09-09", "Description" : "An example template for a Step Functions activity.", "Resources" : { "MyActivity" : { "Type" : "AWS::StepFunctions::Activity", "Properties" : { "Name" : "myActivity", "Tags": [ { "Key": "keyname1", "Value": "value1" }, { "Key": "keyname2", "Value": "value2" } ] } } } }
YAML
AWSTemplateFormatVersion: "2010-09-09" Description: "A sample template for a Step Functions activity" Resources: MyActivity: Type: "AWS::StepFunctions::Activity" Properties: Name: myActivity Tags: - Key: "keyname1" Value: "value1" - Key: "keyname2" Value: "value2"