Interface IStateMachineProps

Properties for defining a State Machine.

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IStateMachineProps

Syntax (vb)

Public Interface 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

Properties

Comment	Comment that describes this state machine.
Definition	(deprecated) Definition for this state machine.
DefinitionBody	Definition for this state machine.
DefinitionSubstitutions	substitutions for the definition body as a key-value map.
EncryptionConfiguration	Configures server-side encryption of the state machine definition and execution history.
Logs	Defines what execution history events are logged and where they are logged.
RemovalPolicy	The removal policy to apply to state machine.
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.

Properties

Comment

Comment that describes this state machine.

virtual string Comment { get; }

Property Value

System.String

Remarks

Default: - No comment

Definition

(deprecated) Definition for this state machine.

virtual IChainable Definition { get; }

Property Value

IChainable

Remarks

Stability: Deprecated

DefinitionBody

Definition for this state machine.

virtual DefinitionBody DefinitionBody { get; }

Property Value

DefinitionBody

DefinitionSubstitutions

substitutions for the definition body as a key-value map.

virtual IDictionary<string, string> DefinitionSubstitutions { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

EncryptionConfiguration

Configures server-side encryption of the state machine definition and execution history.

virtual EncryptionConfiguration EncryptionConfiguration { get; }

Property Value

EncryptionConfiguration

Remarks

Default: - data is transparently encrypted using an AWS owned key

Logs

Defines what execution history events are logged and where they are logged.

virtual ILogOptions Logs { get; }

Property Value

ILogOptions

Remarks

Default: No logging

RemovalPolicy

The removal policy to apply to state machine.

virtual Nullable<RemovalPolicy> RemovalPolicy { get; }

Property Value

System.Nullable<RemovalPolicy>

Remarks

Default: RemovalPolicy.DESTROY

Role

The execution role for the state machine service.

virtual IRole Role { get; }

Property Value

IRole

Remarks

Default: A role is automatically created

StateMachineName

A name for the state machine.

virtual string StateMachineName { get; }

Property Value

System.String

Remarks

Default: A name is automatically generated

StateMachineType

Type of the state machine.

virtual Nullable<StateMachineType> StateMachineType { get; }

Property Value

System.Nullable<StateMachineType>

Remarks

Default: StateMachineType.STANDARD

Timeout

Maximum run time for this state machine.

virtual Duration Timeout { get; }

Property Value

Duration

Remarks

Default: No timeout

TracingEnabled

Specifies whether Amazon X-Ray tracing is enabled for this state machine.

virtual Nullable<bool> TracingEnabled { get; }

Property Value

System.Nullable<System.Boolean>

Remarks

Default: false