JobDefinition

Gets and sets the property ContainerOrchestrationType.

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

Gets and sets the property ContainerProperties.

An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or nodeProperties.

Gets and sets the property EcsProperties.

An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.

Gets and sets the property EksProperties.

An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.

Gets and sets the property JobDefinitionArn.

The Amazon Resource Name (ARN) for the job definition.

Gets and sets the property JobDefinitionName.

The name of the job definition.

Gets and sets the property NodeProperties.

An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.

Gets and sets the property Parameters.

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.

Gets and sets the property PlatformCapabilities.

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Gets and sets the property PropagateTags.

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.

Gets and sets the property RetryStrategy.

The retry strategy to use for failed jobs that are submitted with this job definition.

Gets and sets the property Revision.

The revision of the job definition.

Gets and sets the property SchedulingPriority.

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.

Gets and sets the property Status.

The status of the job definition.

Gets and sets the property Tags.

The tags that are applied to the job definition.

Gets and sets the property Timeout.

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.

Gets and sets the property Type.

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.