Package software.amazon.awscdk.services.stepfunctions

Interface IStateMachine

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGrantable, IResource, IStateMachineRef, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IStateMachine.Jsii$Default

All Known Implementing Classes:

IStateMachine.Jsii$Proxy, StateMachine

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-05T22:26:46.302Z")
@Stability(Stable)
public interface IStateMachine
extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IStateMachineRef

A State Machine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IStateMachine.Jsii$Default	Internal default implementation for IStateMachine.
static final class	IStateMachine.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
ResourceEnvironment	getEnv()	The environment this resource belongs to.
software.constructs.Node	getNode()	The tree node.
String	getStateMachineArn()	The ARN of the state machine.
Grant	grant(IGrantable identity, String... actions)	Grant the given identity custom permissions.
Grant	grantExecution(IGrantable identity, String... actions)	Grant the given identity permissions for all executions of a state machine.
Grant	grantRead(IGrantable identity)	Grant the given identity read permissions for this state machine.
Grant	grantRedriveExecution(IGrantable identity)	Grant the given identity permission to redrive the execution of the state machine.
Grant	grantStartExecution(IGrantable identity)	Grant the given identity permissions to start an execution of this state machine.
Grant	grantStartSyncExecution(IGrantable identity)	Grant the given identity permissions to start a synchronous execution of this state machine.
Grant	grantTaskResponse(IGrantable identity)	Grant the given identity read permissions for this state machine.
Metric	metric(String metricName)	Return the given named metric for this State Machine's executions.
Metric	metric(String metricName, MetricOptions props)	Return the given named metric for this State Machine's executions.
Metric	metricAborted()	Metric for the number of executions that were aborted.
Metric	metricAborted(MetricOptions props)	Metric for the number of executions that were aborted.
Metric	metricFailed()	Metric for the number of executions that failed.
Metric	metricFailed(MetricOptions props)	Metric for the number of executions that failed.
Metric	metricStarted()	Metric for the number of executions that were started.
Metric	metricStarted(MetricOptions props)	Metric for the number of executions that were started.
Metric	metricSucceeded()	Metric for the number of executions that succeeded.
Metric	metricSucceeded(MetricOptions props)	Metric for the number of executions that succeeded.
Metric	metricThrottled()	Metric for the number of executions that were throttled.
Metric	metricThrottled(MetricOptions props)	Metric for the number of executions that were throttled.
Metric	metricTime()	Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
Metric	metricTime(MetricOptions props)	Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
Metric	metricTimedOut()	Metric for the number of executions that timed out.
Metric	metricTimedOut(MetricOptions props)	Metric for the number of executions that timed out.

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.interfaces.stepfunctions.IStateMachineRef

getStateMachineRef

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStateMachineArn

@Stability(Stable)
@NotNull
String getStateMachineArn()

The ARN of the state machine.

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable identity,
 @NotNull
 String... actions)

Grant the given identity custom permissions.

Parameters:

identity - The principal. This parameter is required.

actions - The list of desired actions. This parameter is required.

grantExecution

@Stability(Stable)
@NotNull
Grant grantExecution(@NotNull
 IGrantable identity,
 @NotNull
 String... actions)

Grant the given identity permissions for all executions of a state machine.

Parameters:

identity - The principal. This parameter is required.

actions - The list of desired actions. This parameter is required.

grantRead

@Stability(Stable)
@NotNull
Grant grantRead(@NotNull
 IGrantable identity)

Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.

grantRedriveExecution

@Stability(Stable)
@NotNull
Grant grantRedriveExecution(@NotNull
 IGrantable identity)

Grant the given identity permission to redrive the execution of the state machine.

Parameters:

identity - The principal. This parameter is required.

grantStartExecution

@Stability(Stable)
@NotNull
Grant grantStartExecution(@NotNull
 IGrantable identity)

Grant the given identity permissions to start an execution of this state machine.

Parameters:

identity - The principal. This parameter is required.

grantStartSyncExecution

@Stability(Stable)
@NotNull
Grant grantStartSyncExecution(@NotNull
 IGrantable identity)

Grant the given identity permissions to start a synchronous execution of this state machine.

Parameters:

identity - The principal. This parameter is required.

grantTaskResponse

@Stability(Stable)
@NotNull
Grant grantTaskResponse(@NotNull
 IGrantable identity)

Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.

metric

@Stability(Stable)
@NotNull
Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

Return the given named metric for this State Machine's executions.

Default: - sum over 5 minutes

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Stable)
@NotNull
Metric metric(@NotNull
 String metricName)

Return the given named metric for this State Machine's executions.

Default: - sum over 5 minutes

Parameters:

metricName - This parameter is required.

metricAborted

@Stability(Stable)
@NotNull
Metric metricAborted(@Nullable
 MetricOptions props)

Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

Parameters:

props -

metricAborted

@Stability(Stable)
@NotNull
Metric metricAborted()

Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

metricFailed

@Stability(Stable)
@NotNull
Metric metricFailed(@Nullable
 MetricOptions props)

Metric for the number of executions that failed.

Default: - sum over 5 minutes

Parameters:

props -

metricFailed

@Stability(Stable)
@NotNull
Metric metricFailed()

Metric for the number of executions that failed.

Default: - sum over 5 minutes

metricStarted

@Stability(Stable)
@NotNull
Metric metricStarted(@Nullable
 MetricOptions props)

Metric for the number of executions that were started.

Default: - sum over 5 minutes

Parameters:

props -

metricStarted

@Stability(Stable)
@NotNull
Metric metricStarted()

Metric for the number of executions that were started.

Default: - sum over 5 minutes

metricSucceeded

@Stability(Stable)
@NotNull
Metric metricSucceeded(@Nullable
 MetricOptions props)

Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Parameters:

props -

metricSucceeded

@Stability(Stable)
@NotNull
Metric metricSucceeded()

Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

metricThrottled

@Stability(Stable)
@NotNull
Metric metricThrottled(@Nullable
 MetricOptions props)

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

Parameters:

props -

metricThrottled

@Stability(Stable)
@NotNull
Metric metricThrottled()

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

metricTime

@Stability(Stable)
@NotNull
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

Parameters:

props -

metricTime

@Stability(Stable)
@NotNull
Metric metricTime()

Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.

Default: - sum over 5 minutes

metricTimedOut

@Stability(Stable)
@NotNull
Metric metricTimedOut(@Nullable
 MetricOptions props)

Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Parameters:

props -

metricTimedOut

@Stability(Stable)
@NotNull
Metric metricTimedOut()

Metric for the number of executions that timed out.

Default: - sum over 5 minutes

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware