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

__init__(*, job_definition, job_name, job_queue, array_size=None, attempts=None, container_overrides=None, depends_on=None, integration_pattern=None, payload=None, timeout=None)

Properties for RunBatchJob.

Parameters
  • job_definition (IJobDefinition) – 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 (IJobQueue) – 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 size

  • attempts (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: - 1

  • container_overrides (Optional[ContainerOverrides]) – 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]]) – A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. Default: - No dependencies

  • integration_pattern (Optional[ServiceIntegrationPattern]) – 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]]) – The payload to be passed as parametrs to the batch job. Default: - No parameters are passed

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

stability :stability: experimental

Return type

None

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 :default: - No array size

stability :stability: experimental

Return type

Union[int, float, None]

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

stability :stability: experimental

Return type

Union[int, float, None]

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 :default: - No container overrides

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

Return type

Optional[ContainerOverrides]

depends_on

A list of dependencies for the job.

A job can depend upon a maximum of 20 jobs.

default :default: - No dependencies

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

Return type

Optional[List[JobDependency]]

integration_pattern

The service integration pattern indicates different ways to call TerminateCluster.

The valid value is either FIRE_AND_FORGET or SYNC.

default :default: SYNC

stability :stability: experimental

Return type

Optional[ServiceIntegrationPattern]

job_definition

The job definition used by this job.

stability :stability: experimental

Return type

IJobDefinition

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.

stability :stability: experimental

Return type

str

job_queue

The job queue into which the job is submitted.

stability :stability: experimental

Return type

IJobQueue

payload

The payload to be passed as parametrs to the batch job.

default :default: - No parameters are passed

stability :stability: experimental

Return type

Optional[Mapping[str, Any]]

timeout

The timeout configuration for this SubmitJob operation.

The minimum value for the timeout is 60 seconds.

default :default: - No timeout

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

Return type

Optional[Duration]