StepFunctionsStartExecutionProps

class aws_cdk.aws_stepfunctions_tasks.StepFunctionsStartExecutionProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, state_machine, input=None, name=None)

Bases: aws_cdk.aws_stepfunctions.TaskStateBaseProps

__init__(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, state_machine, input=None, name=None)

Properties for StartExecution.

Parameters
  • 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

  • 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 ‘$’)

  • timeout (Optional[Duration]) – Timeout for the state machine. Default: - None

  • state_machine (IStateMachine) – The Step Functions state machine to start the execution on.

  • input (Optional[TaskInput]) – The JSON input for the execution, same as that of StartExecution. Default: - The state input (JSON path ‘$’)

  • name (Optional[str]) – The name of the execution, same as that of StartExecution. Default: - None

stability :stability: experimental

Return type

None

Attributes

comment

An optional description for this state.

default :default: - No comment

stability :stability: experimental

Return type

Optional[str]

heartbeat

Timeout for the heartbeat.

default :default: - None

stability :stability: experimental

Return type

Optional[Duration]

input

The JSON input for the execution, same as that of StartExecution.

default :default: - The state input (JSON path ‘$’)

see :see: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html stability :stability: experimental

Return type

Optional[TaskInput]

input_path

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 :default: - The entire task input (JSON path ‘$’)

stability :stability: experimental

Return type

Optional[str]

integration_pattern

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

default :default: IntegrationPattern.REQUEST_RESPONSE

see :see: https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token stability :stability: experimental

Return type

Optional[IntegrationPattern]

name

The name of the execution, same as that of StartExecution.

default :default: - None

see :see: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html stability :stability: experimental

Return type

Optional[str]

output_path

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 :default:

  • The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)

stability :stability: experimental

Return type

Optional[str]

result_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.

default :default: - Replaces the entire input with the result (JSON path ‘$’)

stability :stability: experimental

Return type

Optional[str]

state_machine

The Step Functions state machine to start the execution on.

stability :stability: experimental

Return type

IStateMachine

timeout

Timeout for the state machine.

default :default: - None

stability :stability: experimental

Return type

Optional[Duration]