Package 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:

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

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.933Z")
@Stability(Stable)
public class StateMachine
extends Resource
implements IStateMachine

Define a StepFunctions State Machine.

Example:

 import software.amazon.awscdk.services.stepfunctions.*;
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 Artifact inputArtifact = new Artifact();
 Pass startState = new Pass(this, "StartState");
 StateMachine simpleStateMachine = StateMachine.Builder.create(this, "SimpleStateMachine")
         .definition(startState)
         .build();
 StepFunctionInvokeAction stepFunctionAction = StepFunctionInvokeAction.Builder.create()
         .actionName("Invoke")
         .stateMachine(simpleStateMachine)
         .stateMachineInput(StateMachineInput.filePath(inputArtifact.atPath("assets/input.json")))
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("StepFunctions")
         .actions(List.of(stepFunctionAction))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.core.IConstruct

IConstruct.Jsii$Default

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

software.constructs.IConstruct.Jsii$Default

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

IResource.Jsii$Default

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

IStateMachine.Jsii$Default, IStateMachine.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addToRolePolicy(PolicyStatement statement)	Add the given statement to the role's policy.
static IStateMachine	fromStateMachineArn(software.constructs.Construct scope, String id, String stateMachineArn)	Import a state machine.
IPrincipal	getGrantPrincipal()	The principal this state machine is running as.
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	grant(IGrantable identity, @NotNull String... actions)	Grant the given identity custom permissions.
Grant	grantExecution(IGrantable identity, @NotNull String... actions)	Grant the given identity permissions on all executions of the state machine.
Grant	grantRead(IGrantable identity)	Grant the given identity permissions to read results from state machine.
Grant	grantStartExecution(IGrantable identity)	Grant the given identity permissions to start an execution of this state machine.
Grant	grantStartSyncExecution(IGrantable identity)	Grant the given identity permissions to start a synchronous execution of this state machine.
Grant	grantTaskResponse(IGrantable identity)	Grant the given identity task response permissions on a 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 timed out.
Metric	metricTimedOut(MetricOptions props)	Metric for the number of executions that timed out.

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

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

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

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

StateMachine

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

StateMachine

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

StateMachine

@Stability(Stable)
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 Details

fromStateMachineArn

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

Import a state machine.

Parameters:

scope - This parameter is required.

id - This parameter is required.

stateMachineArn - This parameter is required.

addToRolePolicy

@Stability(Stable)
public void addToRolePolicy(@NotNull
 PolicyStatement statement)

Add the given statement to the role's policy.

Parameters:

statement - This parameter is required.

grant

@Stability(Stable)
@NotNull
public Grant grant(@NotNull
 IGrantable identity,
 @NotNull
 @NotNull String... actions)

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(Stable)
@NotNull
public Grant grantExecution(@NotNull
 IGrantable identity,
 @NotNull
 @NotNull String... actions)

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(Stable)
@NotNull
public Grant grantRead(@NotNull
 IGrantable identity)

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(Stable)
@NotNull
public 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 - This parameter is required.

grantStartSyncExecution

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

grantTaskResponse

@Stability(Stable)
@NotNull
public Grant grantTaskResponse(@NotNull
 IGrantable identity)

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(Stable)
@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

Specified by:

metric in interface IStateMachine

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Stable)
@NotNull
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public 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
public Metric metricTime(@Nullable
 MetricOptions props)

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(Stable)
@NotNull
public Metric metricTime()

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(Stable)
@NotNull
public 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
public Metric metricTimedOut()

Metric for the number of executions that timed out.

Default: - sum over 5 minutes

Specified by:

metricTimedOut in interface IStateMachine

getGrantPrincipal

@Stability(Stable)
@NotNull
public IPrincipal getGrantPrincipal()

The principal this state machine is running as.

Specified by:

getGrantPrincipal in interface IGrantable

getRole

@Stability(Stable)
@NotNull
public IRole getRole()

Execution role of this state machine.

getStateMachineArn

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

The ARN of the state machine.

Specified by:

getStateMachineArn in interface IStateMachine

getStateMachineName

@Stability(Stable)
@NotNull
public String getStateMachineName()

The name of the state machine.

getStateMachineType

@Stability(Stable)
@NotNull
public StateMachineType getStateMachineType()

Type of the state machine.