Package software.amazon.awscdk.services.states

Class CfnExecution

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.states.CfnExecution
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IExecutionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:12.579Z") @Stability(Stable) public class CfnExecution extends CfnResource implements IInspectable, IExecutionRef
Represents an AWS Step Functions state machine execution.

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.states.*;
 CfnExecution cfnExecution = CfnExecution.Builder.create(this, "MyCfnExecution")
         .stateMachineArn("stateMachineArn")
         // the properties below are optional
         .input("input")
         .name("name")
         .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

    • CfnExecution

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

    • CfnExecution

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

    • CfnExecution

      @Stability(Stable) public CfnExecution(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnExecutionProps props)
      Create a new AWS::States::Execution.

      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

    • arnForExecution

      @Stability(Stable) @NotNull public static String arnForExecution(@NotNull IExecutionRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnExecution

      @Stability(Stable) @NotNull public static Boolean isCfnExecution(@NotNull Object x)
      Checks whether the given object is a CfnExecution.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrExecutionArn

      @Stability(Stable) @NotNull public String getAttrExecutionArn()
      The Amazon Resource Name (ARN) that identifies the execution.

    • getAttrRedriveCount

      @Stability(Stable) @NotNull public Number getAttrRedriveCount()
      The number of times the execution has been redriven.

    • getAttrRedriveStatus

      @Stability(Stable) @NotNull public String getAttrRedriveStatus()
      Indicates whether or not an execution can be redriven.

    • getAttrStartDate

      @Stability(Stable) @NotNull public String getAttrStartDate()
      The date the execution started.

    • getAttrStateMachineName

      @Stability(Stable) @NotNull public String getAttrStateMachineName()
      The name of the state machine, extracted from the execution ARN.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the execution.

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getExecutionRef

      @Stability(Stable) @NotNull public ExecutionReference getExecutionRef()
      A reference to a Execution resource.
      Specified by:
      getExecutionRef in interface IExecutionRef

    • getStateMachineArn

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

    • setStateMachineArn

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

    • getInput

      @Stability(Stable) @Nullable public String getInput()
      The string that contains the JSON input data for the execution.

    • setInput

      @Stability(Stable) public void setInput(@Nullable String value)
      The string that contains the JSON input data for the execution.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the execution.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the execution.