software.amazon.awscdk.services.stepfunctions

Interface IStateMachine

All Superinterfaces:

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

All Known Subinterfaces:

IStateMachine.Jsii$Default

All Known Implementing Classes:

IStateMachine.Jsii$Proxy, StateMachine

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:38.424Z")
 @Stability(value=Experimental)
public interface IStateMachine
extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable

(experimental) 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
String	getStateMachineArn() (experimental) The ARN of the state machine.
Grant	grant(IGrantable identity, String... actions) (experimental) Grant the given identity custom permissions.
Grant	grantExecution(IGrantable identity, String... actions) (experimental) Grant the given identity permissions for all executions of a state machine.
Grant	grantRead(IGrantable identity) (experimental) Grant the given identity read permissions for this state machine.
Grant	grantStartExecution(IGrantable identity) (experimental) Grant the given identity permissions to start an execution of this state machine.
Grant	grantTaskResponse(IGrantable identity) (experimental) Grant the given identity read permissions for this state machine.
Metric	metric(String metricName) (experimental) Return the given named metric for this State Machine's executions.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this State Machine's executions.
Metric	metricAborted() (experimental) Metric for the number of executions that were aborted.
Metric	metricAborted(MetricOptions props) (experimental) Metric for the number of executions that were aborted.
Metric	metricFailed() (experimental) Metric for the number of executions that failed.
Metric	metricFailed(MetricOptions props) (experimental) Metric for the number of executions that failed.
Metric	metricStarted() (experimental) Metric for the number of executions that were started.
Metric	metricStarted(MetricOptions props) (experimental) Metric for the number of executions that were started.
Metric	metricSucceeded() (experimental) Metric for the number of executions that succeeded.
Metric	metricSucceeded(MetricOptions props) (experimental) Metric for the number of executions that succeeded.
Metric	metricThrottled() (experimental) Metric for the number of executions that were throttled.
Metric	metricThrottled(MetricOptions props) (experimental) Metric for the number of executions that were throttled.
Metric	metricTime() (experimental) Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
Metric	metricTime(MetricOptions props) (experimental) Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.
Metric	metricTimedOut() (experimental) Metric for the number of executions that timed out.
Metric	metricTimedOut(MetricOptions props) (experimental) Metric for the number of executions that timed out.

Methods inherited from interface software.amazon.awscdk.IResource

getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getGrantPrincipal

Method Detail

getStateMachineArn

@Stability(value=Experimental)
 @NotNull
String getStateMachineArn()

(experimental) The ARN of the state machine.

grant

@Stability(value=Experimental)
 @NotNull
Grant grant(@NotNull
                                                     IGrantable identity,
                                                     @NotNull
                                                     String... actions)

(experimental) 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(value=Experimental)
 @NotNull
Grant grantExecution(@NotNull
                                                              IGrantable identity,
                                                              @NotNull
                                                              String... actions)

(experimental) 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(value=Experimental)
 @NotNull
Grant grantRead(@NotNull
                                                         IGrantable identity)

(experimental) Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.

grantStartExecution

@Stability(value=Experimental)
 @NotNull
Grant grantStartExecution(@NotNull
                                                                   IGrantable identity)

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

Parameters:

identity - The principal. This parameter is required.

grantTaskResponse

@Stability(value=Experimental)
 @NotNull
Grant grantTaskResponse(@NotNull
                                                                 IGrantable identity)

(experimental) Grant the given identity read permissions for this state machine.

Parameters:

identity - The principal. This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName,
                                                       @Nullable
                                                       MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName)

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

Default: - sum over 5 minutes

Parameters:

metricName - This parameter is required.

metricAborted

@Stability(value=Experimental)
 @NotNull
Metric metricAborted(@Nullable
                                                              MetricOptions props)

(experimental) Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

Parameters:

props -

metricAborted

@Stability(value=Experimental)
 @NotNull
Metric metricAborted()

(experimental) Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

metricFailed

@Stability(value=Experimental)
 @NotNull
Metric metricFailed(@Nullable
                                                             MetricOptions props)

(experimental) Metric for the number of executions that failed.

Default: - sum over 5 minutes

Parameters:

props -

metricFailed

@Stability(value=Experimental)
 @NotNull
Metric metricFailed()

(experimental) Metric for the number of executions that failed.

Default: - sum over 5 minutes

metricStarted

@Stability(value=Experimental)
 @NotNull
Metric metricStarted(@Nullable
                                                              MetricOptions props)

(experimental) Metric for the number of executions that were started.

Default: - sum over 5 minutes

Parameters:

props -

metricStarted

@Stability(value=Experimental)
 @NotNull
Metric metricStarted()

(experimental) Metric for the number of executions that were started.

Default: - sum over 5 minutes

metricSucceeded

@Stability(value=Experimental)
 @NotNull
Metric metricSucceeded(@Nullable
                                                                MetricOptions props)

(experimental) Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Parameters:

props -

metricSucceeded

@Stability(value=Experimental)
 @NotNull
Metric metricSucceeded()

(experimental) Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

metricThrottled

@Stability(value=Experimental)
 @NotNull
Metric metricThrottled(@Nullable
                                                                MetricOptions props)

(experimental) Metric for the number of executions that were throttled.

Default: sum over 5 minutes

Parameters:

props -

metricThrottled

@Stability(value=Experimental)
 @NotNull
Metric metricThrottled()

(experimental) Metric for the number of executions that were throttled.

Default: sum over 5 minutes

metricTime

@Stability(value=Experimental)
 @NotNull
Metric metricTime(@Nullable
                                                           MetricOptions props)

(experimental) 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(value=Experimental)
 @NotNull
Metric metricTime()

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

Default: - sum over 5 minutes

metricTimedOut

@Stability(value=Experimental)
 @NotNull
Metric metricTimedOut(@Nullable
                                                               MetricOptions props)

(experimental) Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Parameters:

props -

metricTimedOut

@Stability(value=Experimental)
 @NotNull
Metric metricTimedOut()

(experimental) Metric for the number of executions that timed out.

Default: - sum over 5 minutes