software.amazon.awscdk.services.stepfunctions

Class CustomState

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.CustomState

All Implemented Interfaces:

IDependable, IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-02-19T00:19:34.287Z")
 @Stability(value=Stable)
public class CustomState
extends State
implements IChainable, INextable

State defined by supplying Amazon States Language (ASL) in the state machine.

Example:

 import software.amazon.awscdk.services.dynamodb.*;
 // create a table
 Table table = Table.Builder.create(this, "montable")
         .partitionKey(Attribute.builder()
                 .name("id")
                 .type(AttributeType.STRING)
                 .build())
         .build();
 Pass finalStatus = new Pass(this, "final step");
 // States language JSON to put an item into DynamoDB
 // snippet generated from https://docs.aws.amazon.com/step-functions/latest/dg/tutorial-code-snippet.html#tutorial-code-snippet-1
 Map<String, Object> stateJson = Map.of(
         "Type", "Task",
         "Resource", "arn:aws:states:::dynamodb:putItem",
         "Parameters", Map.of(
                 "TableName", table.getTableName(),
                 "Item", Map.of(
                         "id", Map.of(
                                 "S", "MyEntry"))),
         "ResultPath", null);
 // custom state which represents a task to insert data into DynamoDB
 CustomState custom = CustomState.Builder.create(this, "my custom task")
         .stateJson(stateJson)
         .build();
 Chain chain = Chain.start(custom).next(finalStatus);
 StateMachine sm = StateMachine.Builder.create(this, "StateMachine")
         .definition(chain)
         .timeout(Duration.seconds(30))
         .build();
 // don't forget permissions. You need to assign them
 table.grantWriteData(sm);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomState.Builder A fluent builder for CustomState.

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

IChainable.Jsii$Default, IChainable.Jsii$Proxy

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

INextable.Jsii$Default, INextable.Jsii$Proxy

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

IConstruct.Jsii$Default

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<INextable>	getEndStates() Continuable states of this Chainable.
Chain	next(IChainable next) Continue normal execution with the given state.
com.fasterxml.jackson.databind.node.ObjectNode	toStateJson() Returns the Amazon States Language object for this state.

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration, whenBoundToGraph

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.services.stepfunctions.IChainable

getId, getStartState

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CustomState

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

CustomState

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

CustomState

@Stability(value=Stable)
public CustomState(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CustomStateProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

next

@Stability(value=Stable)
 @NotNull
public Chain next(@NotNull
                                                     IChainable next)

Continue normal execution with the given state.

Specified by:

next in interface INextable

Parameters:

next - This parameter is required.

Returns:

The chain of states built up

toStateJson

@Stability(value=Stable)
 @NotNull
public com.fasterxml.jackson.databind.node.ObjectNode toStateJson()

Returns the Amazon States Language object for this state.

Specified by:

toStateJson in class State

getEndStates

@Stability(value=Stable)
 @NotNull
public List<INextable> getEndStates()

Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

Specified by:

getEndStates in class State