software.amazon.awscdk.services.stepfunctions

Interface IStateMachine

All Superinterfaces:

IConstruct, IDependable, IGrantable, IResource

All Known Subinterfaces:

IStateMachine.Jsii$Default

All Known Implementing Classes:

IStateMachine.Jsii$Proxy, StateMachine

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:53.829Z")
public interface IStateMachine
extends IResource, IGrantable

A State Machine.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getStateMachineArn() The ARN of the state machine.
Grant	grant(IGrantable identity, java.lang.String... actions) Grant the given identity custom permissions.
Grant	grantExecution(IGrantable identity, java.lang.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	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(java.lang.String metricName) Return the given named metric for this State Machine's executions.
Metric	metric(java.lang.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.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

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

getGrantPrincipal

Method Detail

getStateMachineArn

java.lang.String getStateMachineArn()

The ARN of the state machine.

grant

Grant grant(IGrantable identity,
            java.lang.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

Grant grantExecution(IGrantable identity,
                     java.lang.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

Grant grantRead(IGrantable identity)

Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.

grantStartExecution

Grant grantStartExecution(IGrantable identity)

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

Parameters:

identity - The principal. This parameter is required.

grantStartSyncExecution

Grant grantStartSyncExecution(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

Grant grantTaskResponse(IGrantable identity)

Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.

metric

Metric metric(java.lang.String metricName,
              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

Metric metric(java.lang.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

Metric metricAborted(MetricOptions props)

Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

Parameters:

props -

metricAborted

Metric metricAborted()

Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

metricFailed

Metric metricFailed(MetricOptions props)

Metric for the number of executions that failed.

Default: - sum over 5 minutes

Parameters:

props -

metricFailed

Metric metricFailed()

Metric for the number of executions that failed.

Default: - sum over 5 minutes

metricStarted

Metric metricStarted(MetricOptions props)

Metric for the number of executions that were started.

Default: - sum over 5 minutes

Parameters:

props -

metricStarted

Metric metricStarted()

Metric for the number of executions that were started.

Default: - sum over 5 minutes

metricSucceeded

Metric metricSucceeded(MetricOptions props)

Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Parameters:

props -

metricSucceeded

Metric metricSucceeded()

Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

metricThrottled

Metric metricThrottled(MetricOptions props)

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

Parameters:

props -

metricThrottled

Metric metricThrottled()

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

metricTime

Metric metricTime(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

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

Metric metricTimedOut(MetricOptions props)

Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Parameters:

props -

metricTimedOut

Metric metricTimedOut()

Metric for the number of executions that timed out.

Default: - sum over 5 minutes