class Choice (construct)

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.Choice
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#Choice
Java	software.amazon.awscdk.services.stepfunctions.Choice
Python	aws_cdk.aws_stepfunctions.Choice
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » Choice

Implements IConstruct, IDependable, IChainable

Define a Choice in the state machine.

A choice state can be used to make decisions based on the execution state.

Example

const map = new sfn.Map(this, 'Map State', {
  maxConcurrency: 1,
  itemsPath: sfn.JsonPath.stringAt('$.inputForMap'),
  itemSelector: {
    item: sfn.JsonPath.stringAt('$$.Map.Item.Value'),
  },
  resultPath: '$.mapOutput',
});

// The Map iterator can contain a IChainable, which can be an individual or multiple steps chained together.
// Below example is with a Choice and Pass step
const choice = new sfn.Choice(this, 'Choice');
const condition1 = sfn.Condition.stringEquals('$.item.status', 'SUCCESS');
const step1 = new sfn.Pass(this, 'Step1');
const step2 = new sfn.Pass(this, 'Step2');
const finish = new sfn.Pass(this, 'Finish');

const definition = choice
    .when(condition1, step1)
    .otherwise(step2)
    .afterwards()
    .next(finish);

map.itemProcessor(definition);

Initializer

new Choice(scope: Construct, id: string, props?: ChoiceProps)

Parameters

• scope Construct
• id string — Descriptive identifier for this chainable.
• props ChoiceProps

Construct Props

Name	Type	Description
comment?	string	An optional description for this state.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
outputPath?	string	JSONPath expression to select part of the state to be the output to this state.
stateName?	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.

Properties

Name	Type	Description
endStates	INextable[]	Continuable states of this Chainable.
id	string	Descriptive identifier for this chainable.
node	Node	The tree node.
startState	State	First state of this Chainable.
stateId	string	Tokenized string that evaluates to the state's ID.

---

endStates

Type: INextable[]

Continuable states of this Chainable.

---

id

Type: string

Descriptive identifier for this chainable.

---

node

Type: Node

The tree node.

---

startState

Type: State

First state of this Chainable.

---

stateId

Type: string

Tokenized string that evaluates to the state's ID.

Methods

Name	Description
addPrefix(x)	Add a prefix to the stateId of this state.
afterwards(options?)	Return a Chain that contains all reachable end states from this Choice.
bindToGraph(graph)	Register this state as part of the given graph.
otherwise(def)	If none of the given conditions match, continue execution with the given state.
toStateJson()	Return the Amazon States Language object for this state.
toString()	Returns a string representation of this construct.
when(condition, next, options?)	If the given condition matches, continue execution with the given state.

---

addPrefix(x)

public addPrefix(x: string): void

Parameters

• x string

Add a prefix to the stateId of this state.

---

afterwards(options?)

public afterwards(options?: AfterwardsOptions): Chain

Parameters

• options AfterwardsOptions

Returns

• Chain

Return a Chain that contains all reachable end states from this Choice.

Use this to combine all possible choice paths back.

---

bindToGraph(graph)

public bindToGraph(graph: StateGraph): void

Parameters

• graph StateGraph

Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

---

otherwise(def)

public otherwise(def: IChainable): Choice

Parameters

• def IChainable

Returns

• Choice

If none of the given conditions match, continue execution with the given state.

If no conditions match and no otherwise() has been given, an execution error will be raised.

---

toStateJson()

public toStateJson(): json

Returns

• json

Return the Amazon States Language object for this state.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

when(condition, next, options?)

public when(condition: Condition, next: IChainable, options?: ChoiceTransitionOptions): Choice

Parameters

• condition Condition
• next IChainable
• options ChoiceTransitionOptions

Returns

• Choice

If the given condition matches, continue execution with the given state.