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, 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.

Nested Class Summary

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

IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.IStateMachine

metric, metricAborted, metricFailed, metricStarted, metricSucceeded, metricThrottled, metricTime, metricTimedOut

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Experimental)
 @NotNull
default ResourceEnvironment getEnv()

(experimental) 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(value=Experimental)
 @NotNull
default Stack getStack()

(experimental) The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
default IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getStateMachineArn

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

(experimental) The ARN of the state machine.

Specified by:

getStateMachineArn in interface IStateMachine

grant

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

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

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

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

(experimental) 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.

grantTaskResponse

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

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

Specified by:

metric in interface IStateMachine

Parameters:

metricName - This parameter is required.

props -

metricAborted

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

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

Default: - sum over 5 minutes

Specified by:

metricAborted in interface IStateMachine

Parameters:

props -

metricFailed

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

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

Default: - sum over 5 minutes

Specified by:

metricFailed in interface IStateMachine

Parameters:

props -

metricStarted

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

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

Default: - sum over 5 minutes

Specified by:

metricStarted in interface IStateMachine

Parameters:

props -

metricSucceeded

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

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

Default: - sum over 5 minutes

Specified by:

metricSucceeded in interface IStateMachine

Parameters:

props -

metricThrottled

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

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

Default: sum over 5 minutes

Specified by:

metricThrottled in interface IStateMachine

Parameters:

props -

metricTime

@Stability(value=Experimental)
 @NotNull
default 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

Specified by:

metricTime in interface IStateMachine

Parameters:

props -

metricTimedOut

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

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

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine

Parameters:

props -