Class StateMachineProps
Properties for defining a State Machine.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.AWS.StepFunctions.dll
Syntax (csharp)
public class StateMachineProps : Object, IStateMachineProps
Syntax (vb)
Public Class StateMachineProps
Inherits Object
Implements IStateMachineProps
Remarks
ExampleMetadata: infused
Examples
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 }
});
Synopsis
Constructors
StateMachineProps() |
Properties
Definition | Definition for this state machine. |
Logs | Defines what execution history events are logged and where they are logged. |
Role | The execution role for the state machine service. |
StateMachineName | A name for the state machine. |
StateMachineType | Type of the state machine. |
Timeout | Maximum run time for this state machine. |
TracingEnabled | Specifies whether Amazon X-Ray tracing is enabled for this state machine. |
Constructors
StateMachineProps()
public StateMachineProps()
Properties
Definition
Definition for this state machine.
public IChainable Definition { get; set; }
Property Value
Logs
Defines what execution history events are logged and where they are logged.
public ILogOptions Logs { get; set; }
Property Value
Remarks
Default: No logging
Role
The execution role for the state machine service.
public IRole Role { get; set; }
Property Value
Remarks
Default: A role is automatically created
StateMachineName
A name for the state machine.
public string StateMachineName { get; set; }
Property Value
System.String
Remarks
Default: A name is automatically generated
StateMachineType
Type of the state machine.
public Nullable<StateMachineType> StateMachineType { get; set; }
Property Value
System.Nullable<StateMachineType>
Remarks
Default: StateMachineType.STANDARD
Timeout
Maximum run time for this state machine.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: No timeout
TracingEnabled
Specifies whether Amazon X-Ray tracing is enabled for this state machine.
public Nullable<bool> TracingEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false