interface ChoiceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.ChoiceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#ChoiceProps |
Java | software.amazon.awscdk.services.stepfunctions.ChoiceProps |
Python | aws_cdk.aws_stepfunctions.ChoiceProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions » ChoiceProps |
Properties for defining a Choice state.
Example
const choice = new sfn.Choice(this, 'What color is it?', {
comment: 'color comment',
});
const handleBlueItem = new sfn.Pass(this, 'HandleBlueItem');
const handleOtherItemColor = new sfn.Pass(this, 'HanldeOtherItemColor');
choice.when(sfn.Condition.stringEquals('$.color', 'BLUE'), handleBlueItem, {
comment: 'blue item comment',
});
choice.otherwise(handleOtherItemColor);
Properties
Name | Type | Description |
---|---|---|
comment? | string | An optional description for this state. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
state | string | Optional name for this state. |
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
inputPath?
Type:
string
(optional, default: $)
JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
outputPath?
Type:
string
(optional, default: $)
JSONPath expression to select part of the state to be the output to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.