interface SucceedProps

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

Properties for defining a Succeed 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 succeedProps: stepfunctions.SucceedProps = {
  comment: 'comment',
  inputPath: 'inputPath',
  outputPath: 'outputPath',
  stateName: 'stateName',
};

Properties

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.