@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:53.869Z")
public interface TaskStateBaseProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.stepfunctions.*; import software.amazon.awscdk.core.*; Object resultSelector; TaskStateBaseProps taskStateBaseProps = TaskStateBaseProps.builder() .comment("comment") .heartbeat(Duration.minutes(30)) .inputPath("inputPath") .integrationPattern(IntegrationPattern.REQUEST_RESPONSE) .outputPath("outputPath") .resultPath("resultPath") .resultSelector(Map.of( "resultSelectorKey", resultSelector)) .timeout(Duration.minutes(30)) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
TaskStateBaseProps.Builder
A builder for
TaskStateBaseProps |
static class |
TaskStateBaseProps.Jsii$Proxy
An implementation for
TaskStateBaseProps |
Modifier and Type | Method and Description |
---|---|
static TaskStateBaseProps.Builder |
builder() |
default java.lang.String |
getComment()
An optional description for this state.
|
default Duration |
getHeartbeat()
Timeout for the heartbeat.
|
default java.lang.String |
getInputPath()
JSONPath expression to select part of the state to be the input to this state.
|
default IntegrationPattern |
getIntegrationPattern()
AWS Step Functions integrates with services directly in the Amazon States Language.
|
default java.lang.String |
getOutputPath()
JSONPath expression to select select a portion of the state output to pass to the next state.
|
default java.lang.String |
getResultPath()
JSONPath expression to indicate where to inject the state's output.
|
default java.util.Map<java.lang.String,java.lang.Object> |
getResultSelector()
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
|
default Duration |
getTimeout()
Timeout for the state machine.
|
default java.lang.String getComment()
Default: - No comment
default Duration getHeartbeat()
Default: - None
default java.lang.String getInputPath()
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
default IntegrationPattern getIntegrationPattern()
You can control these AWS services using service integration patterns
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
default java.lang.String getOutputPath()
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
default java.lang.String getResultPath()
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
default java.util.Map<java.lang.String,java.lang.Object> getResultSelector()
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
default Duration getTimeout()
Default: - None
static TaskStateBaseProps.Builder builder()
TaskStateBaseProps.Builder
of TaskStateBaseProps