Package software.amazon.awscdk.services.stepfunctions

Class CfnStateMachineVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.stepfunctions.CfnStateMachineVersion
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-04T00:39:40.483Z") @Stability(Stable) public class CfnStateMachineVersion extends CfnResource implements IInspectable
Represents a state machine version . A published version uses the latest state machine revision . A revision is an immutable, read-only snapshot of a state machine’s definition and configuration.

You can publish up to 1000 versions for each state machine.

Before you delete a version, make sure that version's ARN isn't being referenced in any long-running workflows or application code outside of the stack.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 CfnStateMachineVersion cfnStateMachineVersion = CfnStateMachineVersion.Builder.create(this, "MyCfnStateMachineVersion")
         .stateMachineArn("stateMachineArn")
         // the properties below are optional
         .description("description")
         .stateMachineRevisionId("stateMachineRevisionId")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnStateMachineVersion

      protected CfnStateMachineVersion(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStateMachineVersion

      protected CfnStateMachineVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStateMachineVersion

      @Stability(Stable) public CfnStateMachineVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnStateMachineVersionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the ARN of the state machine version.

      For example, arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getStateMachineArn

      @Stability(Stable) @NotNull public String getStateMachineArn()
      The Amazon Resource Name (ARN) of the state machine.

    • setStateMachineArn

      @Stability(Stable) public void setStateMachineArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the state machine.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      An optional description of the state machine version.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      An optional description of the state machine version.

    • getStateMachineRevisionId

      @Stability(Stable) @Nullable public String getStateMachineRevisionId()
      Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.

    • setStateMachineRevisionId

      @Stability(Stable) public void setStateMachineRevisionId(@Nullable String value)
      Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.