Interface IChoiceProps

Properties for defining a Choice state.

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IChoiceProps

Syntax (vb)

Public Interface IChoiceProps

Remarks

ExampleMetadata: infused

Examples

var choice = new Choice(this, "What color is it?", new ChoiceProps {
    Comment = "color comment"
});
var handleBlueItem = new Pass(this, "HandleBlueItem");
var handleOtherItemColor = new Pass(this, "HanldeOtherItemColor");
choice.When(Condition.StringEquals("$.color", "BLUE"), handleBlueItem, new ChoiceTransitionOptions {
    Comment = "blue item comment"
});
choice.Otherwise(handleOtherItemColor);

Synopsis

Properties

Comment	An optional description for this state.
InputPath	JSONPath expression to select part of the state to be the input to this state.
OutputPath	JSONPath expression to select part of the state to be the output to this state.
StateName	Optional name for this state.

Properties

Comment

An optional description for this state.

virtual string Comment { get; }

Property Value

System.String

Remarks

Default: No comment

InputPath

JSONPath expression to select part of the state to be the input to this state.

virtual string InputPath { get; }

Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: $

OutputPath

JSONPath expression to select part of the state to be the output to this state.

virtual string OutputPath { get; }

Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

StateName

Optional name for this state.

virtual string StateName { get; }

Property Value

System.String

Remarks

Default: - The construct ID will be used as state name