RunBatchJobProps

class aws_cdk.aws_stepfunctions_tasks.RunBatchJobProps(*, job_definition, job_name, job_queue, array_size=None, attempts=None, container_overrides=None, depends_on=None, integration_pattern=None, payload=None, timeout=None)

Bases: object

(deprecated) Properties for RunBatchJob.

Parameters
  • job_definition (IJobDefinition) – (deprecated) The job definition used by this job.

  • job_name (str) – (deprecated) 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 (IJobQueue) – (deprecated) The job queue into which the job is submitted.

  • array_size (Union[int, float, None]) – (deprecated) 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 (Union[int, float, None]) – (deprecated) 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

  • container_overrides (Optional[ContainerOverrides]) – (deprecated) 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

  • depends_on (Optional[List[JobDependency]]) – (deprecated) A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. Default: - No dependencies

  • integration_pattern (Optional[ServiceIntegrationPattern]) – (deprecated) The service integration pattern indicates different ways to call TerminateCluster. The valid value is either FIRE_AND_FORGET or SYNC. Default: SYNC

  • payload (Optional[Mapping[str, Any]]) – (deprecated) The payload to be passed as parametrs to the batch job. Default: - No parameters are passed

  • timeout (Optional[Duration]) – (deprecated) The timeout configuration for this SubmitJob operation. The minimum value for the timeout is 60 seconds. Default: - No timeout

Deprecated

use BatchSubmitJob

Stability

deprecated

Attributes

array_size

(deprecated) 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

Stability

deprecated

Return type

Union[int, float, None]

attempts

(deprecated) 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

Stability

deprecated

Return type

Union[int, float, None]

container_overrides

(deprecated) 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

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides

Stability

deprecated

Return type

Optional[ContainerOverrides]

depends_on

(deprecated) A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

Default
  • No dependencies

See

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn

Stability

deprecated

Return type

Optional[List[JobDependency]]

integration_pattern

(deprecated) The service integration pattern indicates different ways to call TerminateCluster.

The valid value is either FIRE_AND_FORGET or SYNC.

Default

SYNC

Stability

deprecated

Return type

Optional[ServiceIntegrationPattern]

job_definition

(deprecated) The job definition used by this job.

Stability

deprecated

Return type

IJobDefinition

job_name

(deprecated) 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.

Stability

deprecated

Return type

str

job_queue

(deprecated) The job queue into which the job is submitted.

Stability

deprecated

Return type

IJobQueue

payload

(deprecated) The payload to be passed as parametrs to the batch job.

Default
  • No parameters are passed

Stability

deprecated

Return type

Optional[Mapping[str, Any]]

timeout

(deprecated) The timeout configuration for this SubmitJob operation.

The minimum value for the timeout is 60 seconds.

Default
  • No timeout

See

https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-timeout

Stability

deprecated

Return type

Optional[Duration]