io.cloudshiftdev.awscdk.services.stepfunctions.Wait.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.stepfunctions
import com.fasterxml.jackson.databind.node.ObjectNode
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import kotlin.String
import kotlin.Unit
import kotlin.collections.List
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* Define a Wait state in the state machine.
*
* A Wait state can be used to delay execution of the state machine for a while.
*
* 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_LATEST)
* .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();
* ```
*/
public open class Wait(
cdkObject: software.amazon.awscdk.services.stepfunctions.Wait,
) : State(cdkObject),
INextable {
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: WaitProps,
) :
this(software.amazon.awscdk.services.stepfunctions.Wait(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(WaitProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: WaitProps.Builder.() -> Unit,
) : this(scope, id, WaitProps(props)
)
/**
* Continuable states of this Chainable.
*/
public override fun endStates(): List =
unwrap(this).getEndStates().map(INextable::wrap)
/**
* Continue normal execution with the given state.
*
* @param next
*/
public override fun next(next: IChainable): Chain =
unwrap(this).next(next.let(IChainable.Companion::unwrap)).let(Chain::wrap)
/**
* Return the Amazon States Language object for this state.
*/
public override fun toStateJson(): ObjectNode = unwrap(this).toStateJson()
/**
* A fluent builder for [io.cloudshiftdev.awscdk.services.stepfunctions.Wait].
*/
@CdkDslMarker
public interface Builder {
/**
* An optional description for this state.
*
* Default: No comment
*
* @param comment An optional description for this state.
*/
public fun comment(comment: String)
/**
* Optional name for this state.
*
* Default: - The construct ID will be used as state name
*
* @param stateName Optional name for this state.
*/
public fun stateName(stateName: String)
/**
* Wait duration.
*
* @param time Wait duration.
*/
public fun time(time: WaitTime)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder: software.amazon.awscdk.services.stepfunctions.Wait.Builder =
software.amazon.awscdk.services.stepfunctions.Wait.Builder.create(scope, id)
/**
* An optional description for this state.
*
* Default: No comment
*
* @param comment An optional description for this state.
*/
override fun comment(comment: String) {
cdkBuilder.comment(comment)
}
/**
* Optional name for this state.
*
* Default: - The construct ID will be used as state name
*
* @param stateName Optional name for this state.
*/
override fun stateName(stateName: String) {
cdkBuilder.stateName(stateName)
}
/**
* Wait duration.
*
* @param time Wait duration.
*/
override fun time(time: WaitTime) {
cdkBuilder.time(time.let(WaitTime.Companion::unwrap))
}
public fun build(): software.amazon.awscdk.services.stepfunctions.Wait = cdkBuilder.build()
}
public companion object {
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): Wait {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return Wait(builderImpl.apply(block).build())
}
internal fun wrap(cdkObject: software.amazon.awscdk.services.stepfunctions.Wait): Wait =
Wait(cdkObject)
internal fun unwrap(wrapped: Wait): software.amazon.awscdk.services.stepfunctions.Wait =
wrapped.cdkObject as software.amazon.awscdk.services.stepfunctions.Wait
}
}