Package software.amazon.awscdk.services.stepfunctions

Interface IStateMachine.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, IStateMachine, IStateMachineRef, IStateMachineRef.Jsii$Default, 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, IStateMachineRef.Jsii$Default, IGrantable.Jsii$Default

Internal default implementation for IStateMachine.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IStateMachine

IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.stepfunctions.IStateMachineRef

IStateMachineRef.Jsii$Default, IStateMachineRef.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.constructs.IConstruct.Jsii$Default

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware.Jsii$Default

getEnv

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable.Jsii$Default

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.IResource.Jsii$Default

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.interfaces.stepfunctions.IStateMachineRef.Jsii$Default

getStateMachineRef

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStateMachineArn

@Stability(Stable)
@NotNull
default String getStateMachineArn()

The ARN of the state machine.

Specified by:

getStateMachineArn in interface IStateMachine

grant

@Stability(Stable)
@NotNull
default Grant grant(@NotNull
 IGrantable identity,
 @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
 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.

grantRedriveExecution

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

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

Specified by:

grantRedriveExecution 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 -

metric

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

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.

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 -

metricAborted

@Stability(Stable)
@NotNull
default Metric metricAborted()

Metric for the number of executions that were aborted.

Default: - sum over 5 minutes

Specified by:

metricAborted in interface IStateMachine

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 -

metricFailed

@Stability(Stable)
@NotNull
default Metric metricFailed()

Metric for the number of executions that failed.

Default: - sum over 5 minutes

Specified by:

metricFailed in interface IStateMachine

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 -

metricStarted

@Stability(Stable)
@NotNull
default Metric metricStarted()

Metric for the number of executions that were started.

Default: - sum over 5 minutes

Specified by:

metricStarted in interface IStateMachine

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 -

metricSucceeded

@Stability(Stable)
@NotNull
default Metric metricSucceeded()

Metric for the number of executions that succeeded.

Default: - sum over 5 minutes

Specified by:

metricSucceeded in interface IStateMachine

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 -

metricThrottled

@Stability(Stable)
@NotNull
default Metric metricThrottled()

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

Specified by:

metricThrottled in interface IStateMachine

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 -

metricTime

@Stability(Stable)
@NotNull
default Metric metricTime()

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

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 -

metricTimedOut

@Stability(Stable)
@NotNull
default Metric metricTimedOut()

Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine