cloudshift.awscdk.dsl.services.stepfunctions.tasks.StepFunctionsStartExecutionPropsDsl.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package cloudshift.awscdk.dsl.services.stepfunctions.tasks
import cloudshift.awscdk.common.CdkDslMarker
import cloudshift.awscdk.common.MapBuilder
import cloudshift.awscdk.dsl.services.stepfunctions.CredentialsDsl
import kotlin.Any
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map
import software.amazon.awscdk.Duration
import software.amazon.awscdk.services.stepfunctions.Credentials
import software.amazon.awscdk.services.stepfunctions.IStateMachine
import software.amazon.awscdk.services.stepfunctions.IntegrationPattern
import software.amazon.awscdk.services.stepfunctions.TaskInput
import software.amazon.awscdk.services.stepfunctions.Timeout
import software.amazon.awscdk.services.stepfunctions.tasks.StepFunctionsStartExecutionProps
/**
* Properties for StartExecution.
*
* 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();
* ```
*/
@CdkDslMarker
public class StepFunctionsStartExecutionPropsDsl {
private val cdkBuilder: StepFunctionsStartExecutionProps.Builder =
StepFunctionsStartExecutionProps.builder()
/**
* @param associateWithParent Pass the execution ID from the context object to the execution
* input.
* This allows the Step Functions UI to link child executions from parent executions, making it
* easier to trace execution flow across state machines.
*
* If you set this property to `true`, the `input` property must be an object (provided by
* `sfn.TaskInput.fromObject`) or omitted entirely.
*/
public fun associateWithParent(associateWithParent: Boolean) {
cdkBuilder.associateWithParent(associateWithParent)
}
/**
* @param comment An optional description for this state.
*/
public fun comment(comment: String) {
cdkBuilder.comment(comment)
}
/**
* @param credentials Credentials for an IAM Role that the State Machine assumes for executing the
* task.
* This enables cross-account resource invocations.
*/
public fun credentials(credentials: CredentialsDsl.() -> Unit = {}) {
val builder = CredentialsDsl()
builder.apply(credentials)
cdkBuilder.credentials(builder.build())
}
/**
* @param credentials Credentials for an IAM Role that the State Machine assumes for executing the
* task.
* This enables cross-account resource invocations.
*/
public fun credentials(credentials: Credentials) {
cdkBuilder.credentials(credentials)
}
/**
* @param heartbeat Timeout for the heartbeat.
* @deprecated use `heartbeatTimeout`
*/
@Deprecated(message = "deprecated in CDK")
public fun heartbeat(heartbeat: Duration) {
cdkBuilder.heartbeat(heartbeat)
}
/**
* @param heartbeatTimeout Timeout for the heartbeat.
* [disable-awslint:duration-prop-type] is needed because all props interface in
* aws-stepfunctions-tasks extend this interface
*/
public fun heartbeatTimeout(heartbeatTimeout: Timeout) {
cdkBuilder.heartbeatTimeout(heartbeatTimeout)
}
/**
* @param input The JSON input for the execution, same as that of StartExecution.
*/
public fun input(input: TaskInput) {
cdkBuilder.input(input)
}
/**
* @param inputPath JSONPath expression to select part of the state to be the input to this state.
* May also be the special value JsonPath.DISCARD, which will cause the effective
* input to be the empty object {}.
*/
public fun inputPath(inputPath: String) {
cdkBuilder.inputPath(inputPath)
}
/**
* @param integrationPattern AWS Step Functions integrates with services directly in the Amazon
* States Language.
* You can control these AWS services using service integration patterns
*/
public fun integrationPattern(integrationPattern: IntegrationPattern) {
cdkBuilder.integrationPattern(integrationPattern)
}
/**
* @param name The name of the execution, same as that of StartExecution.
*/
public fun name(name: String) {
cdkBuilder.name(name)
}
/**
* @param outputPath JSONPath expression to select select a portion of the state output to pass to
* the next state.
* May also be the special value JsonPath.DISCARD, which will cause the effective
* output to be the empty object {}.
*/
public fun outputPath(outputPath: String) {
cdkBuilder.outputPath(outputPath)
}
/**
* @param resultPath JSONPath expression to indicate where to inject the state's output.
* May also be the special value JsonPath.DISCARD, which will cause the state's
* input to become its output.
*/
public fun resultPath(resultPath: String) {
cdkBuilder.resultPath(resultPath)
}
/**
* @param resultSelector The JSON that will replace the state's raw result and become the
* effective result before ResultPath is applied.
* You can use ResultSelector to create a payload with values that are static
* or selected from the state's raw result.
*/
public fun resultSelector(resultSelector: MapBuilder.() -> Unit = {}) {
val builder = MapBuilder()
builder.apply(resultSelector)
cdkBuilder.resultSelector(builder.map)
}
/**
* @param resultSelector The JSON that will replace the state's raw result and become the
* effective result before ResultPath is applied.
* You can use ResultSelector to create a payload with values that are static
* or selected from the state's raw result.
*/
public fun resultSelector(resultSelector: Map) {
cdkBuilder.resultSelector(resultSelector)
}
/**
* @param stateMachine The Step Functions state machine to start the execution on.
*/
public fun stateMachine(stateMachine: IStateMachine) {
cdkBuilder.stateMachine(stateMachine)
}
/**
* @param taskTimeout Timeout for the task.
* [disable-awslint:duration-prop-type] is needed because all props interface in
* aws-stepfunctions-tasks extend this interface
*/
public fun taskTimeout(taskTimeout: Timeout) {
cdkBuilder.taskTimeout(taskTimeout)
}
/**
* @param timeout Timeout for the task.
* @deprecated use `taskTimeout`
*/
@Deprecated(message = "deprecated in CDK")
public fun timeout(timeout: Duration) {
cdkBuilder.timeout(timeout)
}
public fun build(): StepFunctionsStartExecutionProps = cdkBuilder.build()
}