Skip to content
v2.277.0

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],
});
python
import aws_cdk.aws_stepfunctions as stepfunctions


pipeline = codepipeline.Pipeline(self, "MyPipeline")
input_artifact = codepipeline.Artifact()
start_state = stepfunctions.Pass(self, "StartState")
simple_state_machine = stepfunctions.StateMachine(self, "SimpleStateMachine",
    definition=start_state
)
step_function_action = codepipeline_actions.StepFunctionInvokeAction(
    action_name="Invoke",
    state_machine=simple_state_machine,
    state_machine_input=codepipeline_actions.StateMachineInput.file_path(input_artifact.at_path("assets/input.json"))
)
pipeline.add_stage(
    stage_name="StepFunctions",
    actions=[step_function_action]
)
java
import software.amazon.awscdk.services.stepfunctions.*;


Pipeline pipeline = new Pipeline(this, "MyPipeline");
Artifact inputArtifact = new Artifact();
Pass startState = new Pass(this, "StartState");
StateMachine simpleStateMachine = StateMachine.Builder.create(this, "SimpleStateMachine")
        .definition(startState)
        .build();
StepFunctionInvokeAction stepFunctionAction = StepFunctionInvokeAction.Builder.create()
        .actionName("Invoke")
        .stateMachine(simpleStateMachine)
        .stateMachineInput(StateMachineInput.filePath(inputArtifact.atPath("assets/input.json")))
        .build();
pipeline.addStage(StageOptions.builder()
        .stageName("StepFunctions")
        .actions(List.of(stepFunctionAction))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.StepFunctions;


var pipeline = new Pipeline(this, "MyPipeline");
var inputArtifact = new Artifact();
var startState = new Pass(this, "StartState");
var simpleStateMachine = new StateMachine(this, "SimpleStateMachine", new StateMachineProps {
    Definition = startState
});
var stepFunctionAction = new StepFunctionInvokeAction(new StepFunctionsInvokeActionProps {
    ActionName = "Invoke",
    StateMachine = simpleStateMachine,
    StateMachineInput = StateMachineInput.FilePath(inputArtifact.AtPath("assets/input.json"))
});
pipeline.AddStage(new StageOptions {
    StageName = "StepFunctions",
    Actions = new [] { stepFunctionAction }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"


pipeline := codepipeline.NewPipeline(this, jsii.String("MyPipeline"))
inputArtifact := codepipeline.NewArtifact()
startState := stepfunctions.NewPass(this, jsii.String("StartState"))
simpleStateMachine := stepfunctions.NewStateMachine(this, jsii.String("SimpleStateMachine"), &StateMachineProps{
	Definition: startState,
})
stepFunctionAction := codepipeline_actions.NewStepFunctionInvokeAction(&StepFunctionsInvokeActionProps{
	ActionName: jsii.String("Invoke"),
	StateMachine: simpleStateMachine,
	StateMachineInput: codepipeline_actions.StateMachineInput_FilePath(inputArtifact.AtPath(jsii.String("assets/input.json"))),
})
pipeline.AddStage(&StageOptions{
	StageName: jsii.String("StepFunctions"),
	Actions: []IAction{
		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.
roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#
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.