aws-cdk-lib.aws_stepfunctions.ChoiceProps

interface ChoiceProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.ChoiceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#ChoiceProps
Javasoftware.amazon.awscdk.services.stepfunctions.ChoiceProps
Pythonaws_cdk.aws_stepfunctions.ChoiceProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions » ChoiceProps

Properties for defining a Choice state.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
const choiceProps: stepfunctions.ChoiceProps = {
  comment: 'comment',
  inputPath: 'inputPath',
  outputPath: 'outputPath',
};

Properties

NameTypeDescription
comment?stringAn optional description for this state.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
outputPath?stringJSONPath expression to select part of the state to be the output to 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 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 DISCARD, which will cause the effective output to be the empty object {}.