Bases: object
Props that are common to all tasks.
comment (Optional
[str
]) – An optional description for this state. Default: - No comment
heartbeat (Optional
[Duration
]) – Timeout for the heartbeat. Default: - None
input_path (Optional
[str
]) – 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 {}. Default: - The entire task input (JSON path ‘$’)
integration_pattern (Optional
[IntegrationPattern
]) – AWS Step Functions integrates with services directly in the Amazon States Language. 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
.
output_path (Optional
[str
]) – 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 {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)
result_path (Optional
[str
]) – 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. Default: - Replaces the entire input with the result (JSON path ‘$’)
result_selector (Optional
[Mapping
[str
, Any
]]) – 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. Default: - None
timeout (Optional
[Duration
]) – Timeout for the state machine. Default: - None
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_stepfunctions as stepfunctions
import aws_cdk.core as cdk
# result_selector: Any
task_state_base_props = stepfunctions.TaskStateBaseProps(
comment="comment",
heartbeat=cdk.Duration.minutes(30),
input_path="inputPath",
integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
output_path="outputPath",
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
timeout=cdk.Duration.minutes(30)
)
Attributes
An optional description for this state.
No comment
Timeout for the heartbeat.
None
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 {}.
The entire task input (JSON path ‘$’)
AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns
IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.
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 {}.
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
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.
Replaces the entire input with the result (JSON path ‘$’)
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.
Timeout for the state machine.
None