GlueStartJobRunProps¶
-
class
aws_cdk.aws_stepfunctions_tasks.
GlueStartJobRunProps
(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, timeout=None, glue_job_name, arguments=None, notify_delay_after=None, security_configuration=None)¶ Bases:
aws_cdk.aws_stepfunctions.TaskStateBaseProps
Properties for starting an AWS Glue job as a task.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentheartbeat (
Optional
[Duration
]) – Timeout for the heartbeat. Default: - Noneinput_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_RESPONSEoutput_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: - Noneglue_job_name (
str
) – Glue job name.arguments (
Optional
[TaskInput
]) – The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself. Default: - Default arguments set in the job definitionnotify_delay_after (
Optional
[Duration
]) – After a job run starts, the number of minutes to wait before sending a job run delay notification. Must be at least 1 minute. Default: - Default delay set in the job definitionsecurity_configuration (
Optional
[str
]) – The name of the SecurityConfiguration structure to be used with this job run. This must match the Glue API Default: - Default configuration set in the job definition
Attributes
-
arguments
¶ The job arguments specifically for this run.
For this job run, they replace the default arguments set in the job definition itself.
- Default
Default arguments set in the job definition
- Return type
Optional
[TaskInput
]
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
glue_job_name
¶ Glue job name.
- Return type
str
-
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
The entire task input (JSON path ‘$’)
- 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
IntegrationPattern.REQUEST_RESPONSE
- See
https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token
- Return type
Optional
[IntegrationPattern
]
-
notify_delay_after
¶ After a job run starts, the number of minutes to wait before sending a job run delay notification.
Must be at least 1 minute.
- Default
Default delay set in the job definition
- Return type
Optional
[Duration
]
-
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
The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path ‘$’)
- 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
Replaces the entire input with the result (JSON path ‘$’)
- Return type
Optional
[str
]
-
security_configuration
¶ The name of the SecurityConfiguration structure to be used with this job run.
This must match the Glue API
- Default
Default configuration set in the job definition
- See
https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-common.html#aws-glue-api-regex-oneLine
- Return type
Optional
[str
]