software.amazon.awscdk.services.stepfunctions

Class StateMachine

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.stepfunctions.StateMachine

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:38.430Z")
 @Stability(value=Experimental)
public class StateMachine
extends Resource
implements IStateMachine

(experimental) Define a StepFunctions State Machine.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateMachine.Builder (experimental) A fluent builder for StateMachine.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	StateMachine(software.constructs.Construct scope, String id, StateMachineProps props)
protected	StateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StateMachine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addToRolePolicy(PolicyStatement statement) (experimental) Add the given statement to the role's policy.
static IStateMachine	fromStateMachineArn(software.constructs.Construct scope, String id, String stateMachineArn) (experimental) Import a state machine.
IPrincipal	getGrantPrincipal() (experimental) The principal this state machine is running as.
IRole	getRole() (experimental) Execution role of this state machine.
String	getStateMachineArn() (experimental) The ARN of the state machine.
String	getStateMachineName() (experimental) The name of the state machine.
StateMachineType	getStateMachineType() (experimental) Type 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 on all executions of the state machine.
Grant	grantRead(IGrantable identity) (experimental) Grant the given identity permissions to read results from 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 task response permissions on a 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 class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

StateMachine

protected StateMachine(software.amazon.jsii.JsiiObjectRef objRef)

StateMachine

protected StateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StateMachine

@Stability(value=Experimental)
public StateMachine(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   StateMachineProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromStateMachineArn

@Stability(value=Experimental)
 @NotNull
public static IStateMachine fromStateMachineArn(@NotNull
                                                                                         software.constructs.Construct scope,
                                                                                         @NotNull
                                                                                         String id,
                                                                                         @NotNull
                                                                                         String stateMachineArn)

(experimental) Import a state machine.

Parameters:

scope - This parameter is required.

id - This parameter is required.

stateMachineArn - This parameter is required.

addToRolePolicy

@Stability(value=Experimental)
public void addToRolePolicy(@NotNull
                                                           PolicyStatement statement)

(experimental) Add the given statement to the role's policy.

Parameters:

statement - This parameter is required.

grant

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

(experimental) Grant the given identity custom permissions.

Specified by:

grant in interface IStateMachine

Parameters:

identity - This parameter is required.

actions - This parameter is required.

grantExecution

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

(experimental) Grant the given identity permissions on all executions of the state machine.

Specified by:

grantExecution in interface IStateMachine

Parameters:

identity - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(value=Experimental)
 @NotNull
public Grant grantRead(@NotNull
                                                                IGrantable identity)

(experimental) Grant the given identity permissions to read results from state machine.

Specified by:

grantRead in interface IStateMachine

Parameters:

identity - This parameter is required.

grantStartExecution

@Stability(value=Experimental)
 @NotNull
public 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 - This parameter is required.

grantTaskResponse

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

(experimental) Grant the given identity task response permissions on a state machine.

Specified by:

grantTaskResponse in interface IStateMachine

Parameters:

identity - This parameter is required.

metric

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

metric

@Stability(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName)

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

metricAborted

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

metricAborted

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

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

Default: - sum over 5 minutes

Specified by:

metricAborted in interface IStateMachine

metricFailed

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

metricFailed

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

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

Default: - sum over 5 minutes

Specified by:

metricFailed in interface IStateMachine

metricStarted

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

metricStarted

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

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

Default: - sum over 5 minutes

Specified by:

metricStarted in interface IStateMachine

metricSucceeded

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

metricSucceeded

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

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

Default: - sum over 5 minutes

Specified by:

metricSucceeded in interface IStateMachine

metricThrottled

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

metricThrottled

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

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

Default: - sum over 5 minutes

Specified by:

metricThrottled in interface IStateMachine

metricTime

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

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

Default: - average over 5 minutes

Specified by:

metricTime in interface IStateMachine

Parameters:

props -

metricTime

@Stability(value=Experimental)
 @NotNull
public Metric metricTime()

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

Default: - average over 5 minutes

Specified by:

metricTime in interface IStateMachine

metricTimedOut

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

metricTimedOut

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

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

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine

getGrantPrincipal

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

(experimental) The principal this state machine is running as.

Specified by:

getGrantPrincipal in interface IGrantable

getRole

@Stability(value=Experimental)
 @NotNull
public IRole getRole()

(experimental) Execution role of this state machine.

getStateMachineArn

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

(experimental) The ARN of the state machine.

Specified by:

getStateMachineArn in interface IStateMachine

getStateMachineName

@Stability(value=Experimental)
 @NotNull
public String getStateMachineName()

(experimental) The name of the state machine.

getStateMachineType

@Stability(value=Experimental)
 @NotNull
public StateMachineType getStateMachineType()

(experimental) Type of the state machine.