EmrContainersStartJobRunProps
- class aws_cdk.aws_stepfunctions_tasks.EmrContainersStartJobRunProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, job_driver, release_label, virtual_cluster, application_config=None, execution_role=None, job_name=None, monitoring=None, tags=None)
Bases:
TaskStateBaseProps
The props for a EMR Containers StartJobRun 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_RESPONSE
for most tasks.IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.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: - Nonetimeout (
Optional
[Duration
]) – Timeout for the state machine. Default: - Nonejob_driver (
Union
[JobDriver
,Dict
[str
,Any
]]) – The job driver for the job run.release_label (
ReleaseLabel
) – The Amazon EMR release version to use for the job run.virtual_cluster (
VirtualClusterInput
) – The ID of the virtual cluster where the job will be run.application_config (
Optional
[Sequence
[Union
[ApplicationConfiguration
,Dict
[str
,Any
]]]]) – The configurations for the application running in the job run. Maximum of 100 items Default: - No application configexecution_role (
Optional
[IRole
]) – The execution role for the job run. IfvirtualClusterId
is from a JSON input path, an execution role must be provided. If an execution role is provided, follow the documentation to update the role trust policy. Default: - Automatically generated only when the providedvirtualClusterId
is not an encoded JSON pathjob_name (
Optional
[str
]) – The name of the job run. Default: - No job run namemonitoring (
Union
[Monitoring
,Dict
[str
,Any
],None
]) – Configuration for monitoring the job run. Default: - logging enabled and resources automatically generated ifmonitoring.logging
is set totrue
tags (
Optional
[Mapping
[str
,str
]]) – The tags assigned to job runs. Default: - None
- ExampleMetadata:
infused
Example:
tasks.EmrContainersStartJobRun(self, "EMR Containers Start Job Run", virtual_cluster=tasks.VirtualClusterInput.from_virtual_cluster_id("de92jdei2910fwedz"), release_label=tasks.ReleaseLabel.EMR_6_2_0, job_name="EMR-Containers-Job", job_driver=tasks.JobDriver( spark_submit_job_driver=tasks.SparkSubmitJobDriver( entry_point=sfn.TaskInput.from_text("local:///usr/lib/spark/examples/src/main/python/pi.py") ) ), application_config=[tasks.ApplicationConfiguration( classification=tasks.Classification.SPARK_DEFAULTS, properties={ "spark.executor.instances": "1", "spark.executor.memory": "512M" } )] )
Attributes
- application_config
The configurations for the application running in the job run.
Maximum of 100 items
- Default:
No application config
- See:
- comment
An optional description for this state.
- Default:
No comment
- execution_role
The execution role for the job run.
If
virtualClusterId
is from a JSON input path, an execution role must be provided. If an execution role is provided, follow the documentation to update the role trust policy.- Default:
Automatically generated only when the provided
virtualClusterId
is not an encoded JSON path
- See:
- heartbeat
Timeout for the heartbeat.
- Default:
None
- 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 ‘$’)
- 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
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.
- job_driver
The job driver for the job run.
- job_name
The name of the job run.
- Default:
No job run name
- monitoring
Configuration for monitoring the job run.
- Default:
logging enabled and resources automatically generated if
monitoring.logging
is set totrue
- See:
- 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 ‘$’)
- release_label
The Amazon EMR release version to use for the job run.
- 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 ‘$’)
- result_selector
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.
- tags
The tags assigned to job runs.
- Default:
None
- timeout
Timeout for the state machine.
- Default:
None
- virtual_cluster
The ID of the virtual cluster where the job will be run.