BatchSubmitJobProps
- class aws_cdk.aws_stepfunctions_tasks.BatchSubmitJobProps(*, comment=None, credentials=None, heartbeat=None, heartbeat_timeout=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, state_name=None, task_timeout=None, timeout=None, job_definition_arn, job_name, job_queue_arn, array_size=None, attempts=None, container_overrides=None, depends_on=None, payload=None, tags=None)
Bases:
TaskStateBaseProps
Properties for RunBatchJob.
- Parameters:
comment (
Optional
[str
]) – An optional description for this state. Default: - No commentcredentials (
Union
[Credentials
,Dict
[str
,Any
],None
]) – Credentials for an IAM Role that the State Machine assumes for executing the task. This enables cross-account resource invocations. Default: - None (Task is executed using the State Machine’s execution role)heartbeat (
Optional
[Duration
]) – (deprecated) Timeout for the heartbeat. Default: - Noneheartbeat_timeout (
Optional
[Timeout
]) – Timeout for the heartbeat. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface 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. Depending on the AWS Service, the Service Integration Pattern availability will vary. 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: - Nonestate_name (
Optional
[str
]) – Optional name for this state. Default: - The construct ID will be used as state nametask_timeout (
Optional
[Timeout
]) – Timeout for the task. [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface Default: - Nonetimeout (
Optional
[Duration
]) – (deprecated) Timeout for the task. Default: - Nonejob_definition_arn (
str
) – The arn of the job definition used by this job.job_name (
str
) – The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.job_queue_arn (
str
) – The arn of the job queue into which the job is submitted.array_size (
Union
[int
,float
,None
]) – The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide. Default: - No array sizeattempts (
Union
[int
,float
,None
]) – The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value. Default: 1container_overrides (
Union
[BatchContainerOverrides
,Dict
[str
,Any
],None
]) – A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. Default: - No container overridesdepends_on (
Optional
[Sequence
[Union
[BatchJobDependency
,Dict
[str
,Any
]]]]) – A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. Default: - No dependenciespayload (
Optional
[TaskInput
]) – The payload to be passed as parameters to the batch job. Default: - No parameters are passedtags (
Optional
[Mapping
[str
,str
]]) – The tags applied to the job request. Default: {} - no tags
- ExampleMetadata:
infused
Example:
import aws_cdk.aws_batch as batch # batch_job_definition: batch.EcsJobDefinition # batch_queue: batch.JobQueue task = tasks.BatchSubmitJob(self, "Submit Job", job_definition_arn=batch_job_definition.job_definition_arn, job_name="MyJob", job_queue_arn=batch_queue.job_queue_arn )
Attributes
- array_size
The array size can be between 2 and 10,000.
If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
- Default:
No array size
- attempts
The number of times to move a job to the RUNNABLE status.
You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
- Default:
1
- comment
An optional description for this state.
- Default:
No comment
- container_overrides
A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.
- Default:
No container overrides
- See:
- credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
- Default:
None (Task is executed using the State Machine’s execution role)
- See:
https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
- depends_on
A list of dependencies for the job.
A job can depend upon a maximum of 20 jobs.
- Default:
No dependencies
- See:
- heartbeat
(deprecated) Timeout for the heartbeat.
- Default:
None
- Deprecated:
use
heartbeatTimeout
- Stability:
deprecated
- heartbeat_timeout
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
- 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.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
- Default:
IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:BatchSubmitJob
,EmrAddStep
,EmrCreateCluster
,EmrTerminationCluster
, andEmrContainersStartJobRun
.
- job_definition_arn
The arn of the job definition used by this job.
- job_name
The name of the job.
The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
- job_queue_arn
The arn of the job queue into which the job is submitted.
- 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 ‘$’)
- payload
The payload to be passed as parameters to the batch job.
- Default:
No parameters are passed
- 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.
- state_name
Optional name for this state.
- Default:
The construct ID will be used as state name
- tags
The tags applied to the job request.
- Default:
{} - no tags
- task_timeout
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
- Default:
None
- timeout
(deprecated) Timeout for the task.
- Default:
None
- Deprecated:
use
taskTimeout
- Stability:
deprecated