software.amazon.awscdk.services.stepfunctions

Enum IntegrationPattern

java.lang.Object

java.lang.Enum<IntegrationPattern>

software.amazon.awscdk.services.stepfunctions.IntegrationPattern

All Implemented Interfaces:

Serializable, Comparable<IntegrationPattern>

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-13T22:11:54.690Z")
 @Stability(value=Stable)
public enum IntegrationPattern
extends Enum<IntegrationPattern>

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns:

Example:

 // Define a state machine with one Pass state
 StateMachine child = StateMachine.Builder.create(this, "ChildStateMachine")
         .definition(Chain.start(new Pass(this, "PassState")))
         .build();
 // Include the state machine in a Task state with callback pattern
 StepFunctionsStartExecution task = StepFunctionsStartExecution.Builder.create(this, "ChildTask")
         .stateMachine(child)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .input(TaskInput.fromObject(Map.of(
                 "token", JsonPath.getTaskToken(),
                 "foo", "bar")))
         .name("MyExecutionName")
         .build();
 // Define a second state machine with the Task state above
 // Define a second state machine with the Task state above
 StateMachine.Builder.create(this, "ParentStateMachine")
         .definition(task)
         .build();
 

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html

Enum Constant Summary

Enum Constants

Enum Constant and Description
REQUEST_RESPONSE Step Functions will wait for an HTTP response and then progress to the next state.
RUN_JOB Step Functions can wait for a request to complete before progressing to the next state.
WAIT_FOR_TASK_TOKEN Callback tasks provide a way to pause a workflow until a task token is returned.

Method Summary

Modifier and Type	Method and Description
static IntegrationPattern	valueOf(String name) Returns the enum constant of this type with the specified name.
static IntegrationPattern[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUEST_RESPONSE

@Stability(value=Stable)
public static final IntegrationPattern REQUEST_RESPONSE

Step Functions will wait for an HTTP response and then progress to the next state.

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-default

RUN_JOB

@Stability(value=Stable)
public static final IntegrationPattern RUN_JOB

Step Functions can wait for a request to complete before progressing to the next state.

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync

WAIT_FOR_TASK_TOKEN

@Stability(value=Stable)
public static final IntegrationPattern WAIT_FOR_TASK_TOKEN

Callback tasks provide a way to pause a workflow until a task token is returned.

You must set a task token when using the callback pattern

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

Method Detail

values

public static IntegrationPattern[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IntegrationPattern c : IntegrationPattern.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IntegrationPattern valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null