AWS Fundamentals Logo
AWS Fundamentals
AWS::StepFunctions::StateMachine

StepFunctions StateMachine

Resource schema for StateMachine

Properties

11 configurable properties. 1 required. Click a row to see details.

Filter:
PropertyTypeFlags
RoleArn
string
Required
Definition
Definition
Write-only
DefinitionS3Location
S3Location
Write-only
DefinitionString
string
DefinitionSubstitutions
DefinitionSubstitutions
Write-only
EncryptionConfiguration
EncryptionConfiguration
LoggingConfiguration
LoggingConfiguration
StateMachineName
string
Create-only
StateMachineType
string
Create-only
Tags
Array<TagsEntry>
TracingConfiguration
TracingConfiguration

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
Namestring-
StateMachineRevisionIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::StepFunctions::StateMachine

Resources:
  MyResource:
    Type: AWS::StepFunctions::StateMachine
    Properties:
      RoleArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

states:CreateStateMachinestates:DescribeStateMachinestates:TagResourceiam:PassRoles3:GetObjectkms:DescribeKeykms:GenerateDataKey

read

states:DescribeStateMachinestates:ListTagsForResourcekms:Decrypt

update

states:UpdateStateMachinestates:TagResourcestates:UntagResourcestates:ListTagsForResourceiam:PassRolekms:DescribeKeykms:GenerateDataKey

delete

states:DeleteStateMachinestates:DescribeStateMachine

list

states:ListStateMachines

Get the StepFunctions Cheat Sheet

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

Download Free Infographic

Quick Facts

ServiceStepFunctions
Properties14
Required1
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

StateMachineNameStateMachineType

Related Resources

External Links