software.amazon.awscdk.services.stepfunctions

Class WaitTime

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.WaitTime

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.411Z")
 @Stability(value=Stable)
public class WaitTime
extends software.amazon.jsii.JsiiObject

Represents the Wait state which delays a state machine from continuing for a specified time.

Example:

 EvaluateExpression convertToSeconds = EvaluateExpression.Builder.create(this, "Convert to seconds")
         .expression("$.waitMilliseconds / 1000")
         .resultPath("$.waitSeconds")
         .build();
 EvaluateExpression createMessage = EvaluateExpression.Builder.create(this, "Create message")
         // Note: this is a string inside a string.
         .expression("`Now waiting ${$.waitSeconds} seconds...`")
         .runtime(Runtime.NODEJS_14_X)
         .resultPath("$.message")
         .build();
 SnsPublish publishMessage = SnsPublish.Builder.create(this, "Publish message")
         .topic(new Topic(this, "cool-topic"))
         .message(TaskInput.fromJsonPathAt("$.message"))
         .resultPath("$.sns")
         .build();
 Wait wait = Wait.Builder.create(this, "Wait")
         .time(WaitTime.secondsPath("$.waitSeconds"))
         .build();
 StateMachine.Builder.create(this, "StateMachine")
         .definition(convertToSeconds.next(createMessage).next(publishMessage).next(wait))
         .build();
 

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-wait-state.html

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WaitTime(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	WaitTime(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static WaitTime	duration(Duration duration) Wait a fixed amount of time.
static WaitTime	secondsPath(String path) Wait for a number of seconds stored in the state object.
static WaitTime	timestamp(String timestamp) Wait until the given ISO8601 timestamp.
static WaitTime	timestampPath(String path) Wait until a timestamp found in the state object.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

WaitTime

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

WaitTime

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

Method Detail

duration

@Stability(value=Stable)
 @NotNull
public static WaitTime duration(@NotNull
                                                                   Duration duration)

Wait a fixed amount of time.

Parameters:

duration - This parameter is required.

secondsPath

@Stability(value=Stable)
 @NotNull
public static WaitTime secondsPath(@NotNull
                                                                      String path)

Wait for a number of seconds stored in the state object.

Example value: $.waitSeconds

Parameters:

path - This parameter is required.

timestamp

@Stability(value=Stable)
 @NotNull
public static WaitTime timestamp(@NotNull
                                                                    String timestamp)

Wait until the given ISO8601 timestamp.

Example value: 2016-03-14T01:59:00Z

Parameters:

timestamp - This parameter is required.

timestampPath

@Stability(value=Stable)
 @NotNull
public static WaitTime timestampPath(@NotNull
                                                                        String path)

Wait until a timestamp found in the state object.

Example value: $.waitTimestamp

Parameters:

path - This parameter is required.