JobDefinition
An object that represents an Batch job definition.
Types
Properties
The orchestration type of the compute environment. The valid values are ECS
(default) or EKS
.
An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
The Amazon Resource Name (ARN) for the job definition.
The name of the job definition.
An object with various properties that are specific to multi-node parallel jobs. Valid values are containerProperties
, eksProperties
, and nodeProperties
. Only one can be specified.
Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob
request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.
The platform capabilities required by the job definition. If no value is specified, it defaults to EC2
. Jobs run on Fargate resources specify FARGATE
.
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED
state.
The retry strategy to use for failed jobs that are submitted with this job definition.
The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.
The type of job definition. It's either container
or multinode
. If the job is run on Fargate resources, then multinode
isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.