StateMachine
Define a StepFunctions State Machine.
Import
import { StateMachine } from 'aws-cdk-lib/aws-stepfunctions';Or use the module namespace:
import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
// stepfunctions.StateMachineProperties
Configuration passed to the constructor as StateMachineProps.
commentOptionalstringComment that describes this state machine.
Default: - No comment
definitionOptionalDeprecatedIChainableDefinition for this state machine.
Deprecated: use definitionBody: DefinitionBody.fromChainable()
definitionBodyOptionalDefinitionBodyDefinition for this state machine.
definitionSubstitutionsOptional{ [key: string]: string }substitutions for the definition body as a key-value map.
encryptionConfigurationOptionalEncryptionConfigurationConfigures server-side encryption of the state machine definition and execution history.
Default: - data is transparently encrypted using an AWS owned key
logsOptionalLogOptionsDefines what execution history events are logged and where they are logged.
Default: No logging
queryLanguageOptionalQueryLanguageThe name of the query language used by the state machine. If the state does not contain a `queryLanguage` field, then it will use the query language specified in this `queryLanguage` field.
Default: - JSON_PATH
removalPolicyOptionalRemovalPolicyThe removal policy to apply to state machine.
Default: RemovalPolicy.DESTROY
roleOptionalIRoleThe execution role for the state machine service.
Default: A role is automatically created
stateMachineNameOptionalstringA name for the state machine.
Default: A name is automatically generated
stateMachineTypeOptionalStateMachineTypeType of the state machine.
Default: StateMachineType.STANDARD
timeoutOptionalDurationMaximum run time for this state machine.
Default: No timeout
tracingEnabledOptionalbooleanSpecifies whether Amazon X-Ray tracing is enabled for this state machine.
Default: false
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 InfographicQuick Facts
aws-stepfunctionsRelated Constructs
- ActivityL2
- ChoiceL2
- CustomStateL2
- DistributedMapL2
- FailL2
- MapL2
- ParallelL2
- PassL2
- SucceedL2
- WaitL2