software.amazon.awscdk.services.stepfunctions

Class StateMachine

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.stepfunctions.StateMachine

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-15T23:35:58.927Z")
 @Stability(value=Experimental)
public class StateMachine
extends Resource
implements IStateMachine

Define a StepFunctions State Machine.

EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StateMachine.Builder 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$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	StateMachine(Construct scope, String id, StateMachineProps props) EXPERIMENTAL
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) Add the given statement to the role's policy.
static IStateMachine	fromStateMachineArn(Construct scope, String id, String stateMachineArn) Import a state machine.
IRole	getRole() Execution role of this state machine.
String	getStateMachineArn() The ARN of the state machine.
String	getStateMachineName() The name of the state machine.
StateMachineType	getStateMachineType() Type of the state machine.
Grant	grantStartExecution(IGrantable identity) Grant the given identity permissions to start an execution of this state machine.
Metric	metric(String metricName) Return the given named metric for this State Machine's executions.
Metric	metric(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 succeeded.
Metric	metricTimedOut(MetricOptions props) Metric for the number of executions that succeeded.

Methods inherited from class software.amazon.awscdk.core.Resource

generatePhysicalName, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, 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.core.IResource

getStack

Methods inherited from interface software.amazon.awscdk.core.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
                                                   Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   StateMachineProps props)

EXPERIMENTAL

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
                                                                                         Construct scope,
                                                                                         @NotNull
                                                                                         String id,
                                                                                         @NotNull
                                                                                         String stateMachineArn)

Import a state machine.

EXPERIMENTAL

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)

Add the given statement to the role's policy.

EXPERIMENTAL

Parameters:

statement - This parameter is required.

grantStartExecution

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

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

EXPERIMENTAL

Specified by:

grantStartExecution in interface IStateMachine

Parameters:

identity - This parameter is required.

metric

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

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

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

metricName - This parameter is required.

props -

metric

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

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

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

metricName - This parameter is required.

metricAborted

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

Metric for the number of executions that were aborted.

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

props -

metricAborted

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

Metric for the number of executions that were aborted.

Default: sum over 5 minutes

EXPERIMENTAL

metricFailed

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

Metric for the number of executions that failed.

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

props -

metricFailed

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

Metric for the number of executions that failed.

Default: sum over 5 minutes

EXPERIMENTAL

metricStarted

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

Metric for the number of executions that were started.

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

props -

metricStarted

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

Metric for the number of executions that were started.

Default: sum over 5 minutes

EXPERIMENTAL

metricSucceeded

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

Metric for the number of executions that succeeded.

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

props -

metricSucceeded

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

Metric for the number of executions that succeeded.

Default: sum over 5 minutes

EXPERIMENTAL

metricThrottled

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

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

props -

metricThrottled

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

Metric for the number of executions that were throttled.

Default: sum over 5 minutes

EXPERIMENTAL

metricTime

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

EXPERIMENTAL

Parameters:

props -

metricTime

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

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

Default: sum over 5 minutes

EXPERIMENTAL

metricTimedOut

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

Metric for the number of executions that succeeded.

Default: sum over 5 minutes

EXPERIMENTAL

Parameters:

props -

metricTimedOut

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

Metric for the number of executions that succeeded.

Default: sum over 5 minutes

EXPERIMENTAL

getRole

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

Execution role of this state machine.

EXPERIMENTAL

getStateMachineArn

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

The ARN of the state machine.

EXPERIMENTAL

Specified by:

getStateMachineArn in interface IStateMachine

getStateMachineName

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

The name of the state machine.

EXPERIMENTAL

getStateMachineType

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

Type of the state machine.

EXPERIMENTAL