Package software.amazon.awscdk.services.stepfunctions

Interface IStateMachine.Jsii$Default

All Superinterfaces:
IConstruct, software.constructs.IConstruct, IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, IStateMachine, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IStateMachine.Jsii$Proxy
Enclosing interface:
IStateMachine
@Internal public static interface IStateMachine.Jsii$Default extends IStateMachine, IResource.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IStateMachine.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default ConstructNode getNode()
      The construct tree node for this construct.
      Specified by:
      getNode in interface IConstruct
      Specified by:
      getNode in interface IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getGrantPrincipal

      @Stability(Stable) @NotNull default IPrincipal getGrantPrincipal()
      The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable
      Specified by:
      getGrantPrincipal in interface IGrantable.Jsii$Default

    • getStateMachineArn

      @Stability(Stable) @NotNull default String getStateMachineArn()
      The ARN of the state machine.
      Specified by:
      getStateMachineArn in interface IStateMachine

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • grant

      @Stability(Stable) @NotNull default Grant grant(@NotNull IGrantable identity, @NotNull @NotNull String... actions)
      Grant the given identity custom permissions.

      Specified by:
      grant in interface IStateMachine
      Parameters:
      identity - The principal. This parameter is required.
      actions - The list of desired actions. This parameter is required.

    • grantExecution

      @Stability(Stable) @NotNull default Grant grantExecution(@NotNull IGrantable identity, @NotNull @NotNull String... actions)
      Grant the given identity permissions for all executions of a state machine.

      Specified by:
      grantExecution in interface IStateMachine
      Parameters:
      identity - The principal. This parameter is required.
      actions - The list of desired actions. This parameter is required.

    • grantRead

      @Stability(Stable) @NotNull default Grant grantRead(@NotNull IGrantable identity)
      Grant the given identity read permissions for this state machine.

      Specified by:
      grantRead in interface IStateMachine
      Parameters:
      identity - The principal. This parameter is required.

    • grantStartExecution

      @Stability(Stable) @NotNull default Grant grantStartExecution(@NotNull IGrantable identity)
      Grant the given identity permissions to start an execution of this state machine.

      Specified by:
      grantStartExecution in interface IStateMachine
      Parameters:
      identity - The principal. This parameter is required.

    • grantStartSyncExecution

      @Stability(Stable) @NotNull default Grant grantStartSyncExecution(@NotNull IGrantable identity)
      Grant the given identity permissions to start a synchronous execution of this state machine.

      Specified by:
      grantStartSyncExecution in interface IStateMachine
      Parameters:
      identity - The principal. This parameter is required.

    • grantTaskResponse

      @Stability(Stable) @NotNull default Grant grantTaskResponse(@NotNull IGrantable identity)
      Grant the given identity read permissions for this state machine.

      Specified by:
      grantTaskResponse in interface IStateMachine
      Parameters:
      identity - The principal. This parameter is required.

    • metric

      @Stability(Stable) @NotNull default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this State Machine's executions.

      Default: - sum over 5 minutes

      Specified by:
      metric in interface IStateMachine
      Parameters:
      metricName - This parameter is required.
      props -

    • metricAborted

      @Stability(Stable) @NotNull default Metric metricAborted(@Nullable MetricOptions props)
      Metric for the number of executions that were aborted.

      Default: - sum over 5 minutes

      Specified by:
      metricAborted in interface IStateMachine
      Parameters:
      props -

    • metricFailed

      @Stability(Stable) @NotNull default Metric metricFailed(@Nullable MetricOptions props)
      Metric for the number of executions that failed.

      Default: - sum over 5 minutes

      Specified by:
      metricFailed in interface IStateMachine
      Parameters:
      props -

    • metricStarted

      @Stability(Stable) @NotNull default Metric metricStarted(@Nullable MetricOptions props)
      Metric for the number of executions that were started.

      Default: - sum over 5 minutes

      Specified by:
      metricStarted in interface IStateMachine
      Parameters:
      props -

    • metricSucceeded

      @Stability(Stable) @NotNull default Metric metricSucceeded(@Nullable MetricOptions props)
      Metric for the number of executions that succeeded.

      Default: - sum over 5 minutes

      Specified by:
      metricSucceeded in interface IStateMachine
      Parameters:
      props -

    • metricThrottled

      @Stability(Stable) @NotNull default Metric metricThrottled(@Nullable MetricOptions props)
      Metric for the number of executions that were throttled.

      Default: sum over 5 minutes

      Specified by:
      metricThrottled in interface IStateMachine
      Parameters:
      props -

    • metricTime

      @Stability(Stable) @NotNull default Metric metricTime(@Nullable MetricOptions props)
      Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.

      Default: - sum over 5 minutes

      Specified by:
      metricTime in interface IStateMachine
      Parameters:
      props -

    • metricTimedOut

      @Stability(Stable) @NotNull default Metric metricTimedOut(@Nullable MetricOptions props)
      Metric for the number of executions that timed out.

      Default: - sum over 5 minutes

      Specified by:
      metricTimedOut in interface IStateMachine
      Parameters:
      props -