aws-cdk-lib.aws_stepfunctions.CfnStateMachineVersionProps

CfnStateMachineVersionProps Struct

Properties for defining a CfnStateMachineVersion.

Source

Generated code

Type last changed

v2.86.0 · 29 Jun 2023

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 cfnStateMachineVersionProps: stepfunctions.CfnStateMachineVersionProps = {
  stateMachineArn: 'stateMachineArn',

  // the properties below are optional
  description: 'description',
  stateMachineRevisionId: 'stateMachineRevisionId',
};

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

An optional description of the state machine version.

stateMachineArnstringstate_machine_arnstrstateMachineArnStringStateMachineArnstringStateMachineArn*stringrequired#

The Amazon Resource Name (ARN) of the state machine.

stateMachineRevisionIdstringstate_machine_revision_idstrstateMachineRevisionIdStringStateMachineRevisionIdstringStateMachineRevisionId*string#

Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.

notes

Only publish the state machine version if the current state machine's revision ID matches the specified ID. Use this option to avoid publishing a version if the state machine has changed since you last updated it.

To specify the initial state machine revision, set the value as INITIAL .

Used as props by

• CfnStateMachineVersion