StateMachineProps Struct
Properties for defining a State Machine.
Example
ts
import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
const pipeline = new codepipeline.Pipeline(this, 'MyPipeline');
const inputArtifact = new codepipeline.Artifact();
const startState = new stepfunctions.Pass(this, 'StartState');
const simpleStateMachine = new stepfunctions.StateMachine(this, 'SimpleStateMachine', {
definition: startState,
});
const stepFunctionAction = new codepipeline_actions.StepFunctionInvokeAction({
actionName: 'Invoke',
stateMachine: simpleStateMachine,
stateMachineInput: codepipeline_actions.StateMachineInput.filePath(inputArtifact.atPath('assets/input.json')),
});
pipeline.addStage({
stageName: 'StepFunctions',
actions: [stepFunctionAction],
});
Properties
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#Comment that describes this state machine.
Default: No comment
definitionoptionalIChainabledefinitionoptionalIChainabledefinitionoptionalIChainableDefinitionoptionalIChainableDefinitionoptionalIChainabledeprecated#use definitionBody: DefinitionBody.fromChainable()
definitionBodyoptionalDefinitionBodydefinition_bodyoptionalDefinitionBodydefinitionBodyoptionalDefinitionBodyDefinitionBodyoptionalDefinitionBodyDefinitionBodyoptionalDefinitionBody#Definition for this state machine.
definitionSubstitutionsoptional{ [key: string]: string }definition_substitutionsoptionaltyping.Mapping[str, str]definitionSubstitutionsoptionalMap<String, String>DefinitionSubstitutionsoptionalIDictionary<string, string>DefinitionSubstitutionsoptional*map[string]*string#substitutions for the definition body as a key-value map.
encryptionConfigurationoptionalEncryptionConfigurationencryption_configurationoptionalEncryptionConfigurationencryptionConfigurationoptionalEncryptionConfigurationEncryptionConfigurationoptionalEncryptionConfigurationEncryptionConfigurationoptionalEncryptionConfiguration#Configures server-side encryption of the state machine definition and execution history.
Default: data is transparently encrypted using an AWS owned key
logsoptionalLogOptionslogsoptionalLogOptionslogsoptionalLogOptionsLogsoptionalLogOptionsLogsoptionalLogOptions#Defines what execution history events are logged and where they are logged.
Default: No logging
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSON_PATH#The 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.
removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#The removal policy to apply to state machine.
The execution role for the state machine service.
Default: A role is automatically created
stateMachineNameoptionalstringstate_machine_nameoptionalstrstateMachineNameoptionalStringStateMachineNameoptionalstringStateMachineNameoptional*string#A name for the state machine.
Default: A name is automatically generated
stateMachineTypeoptionalStateMachineTypestate_machine_typeoptionalStateMachineTypestateMachineTypeoptionalStateMachineTypeStateMachineTypeoptionalStateMachineTypeStateMachineTypeoptionalStateMachineType= StateMachineType.STANDARD#Type of the state machine.
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration#Maximum run time for this state machine.
Default: No timeout
tracingEnabledoptionalbooleantracing_enabledoptionalbooltracingEnabledoptionalBooleanTracingEnabledoptionalboolTracingEnabledoptional*bool= false#Specifies whether Amazon X-Ray tracing is enabled for this state machine.