AWS::Batch::JobDefinition
The AWS::Batch::JobDefinition
resource specifies the parameters for an
Amazon Batch job definition. For more information, see Job
Definitions in the
Amazon Batch User Guide
.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Batch::JobDefinition", "Properties" : { "ContainerProperties" :
ContainerProperties
, "EcsProperties" :EcsProperties
, "EksProperties" :EksProperties
, "JobDefinitionName" :String
, "NodeProperties" :NodeProperties
, "Parameters" :Json
, "PlatformCapabilities" :[ String, ... ]
, "PropagateTags" :Boolean
, "RetryStrategy" :RetryStrategy
, "SchedulingPriority" :Integer
, "Tags" :[
, "Timeout" :Tag
, ... ]Timeout
, "Type" :String
} }
YAML
Type: AWS::Batch::JobDefinition Properties: ContainerProperties:
ContainerProperties
EcsProperties:EcsProperties
EksProperties:EksProperties
JobDefinitionName:String
NodeProperties:NodeProperties
Parameters:Json
PlatformCapabilities:- String
PropagateTags:Boolean
RetryStrategy:RetryStrategy
SchedulingPriority:Integer
Tags:-
Timeout:Tag
Timeout
Type:String
Properties
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 toeksProperties
,ecsProperties
, ornodeProperties
.Required: No
Type: ContainerProperties
Update requires: No interruption
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 tocontainerProperties
,eksProperties
, ornodeProperties
.Required: No
Type: EcsProperties
Update requires: No interruption
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 tocontainerProperties
,ecsProperties
, ornodeProperties
.Required: No
Type: EksProperties
Update requires: No interruption
JobDefinitionName
-
The name of the job definition.
Required: No
Type: String
Update requires: Replacement
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 tocontainerProperties
,ecsProperties
, oreksProperties
.Note
If the job runs on Fargate resources, don't specify
nodeProperties
. UsecontainerProperties
instead.Required: No
Type: NodeProperties
Update requires: No interruption
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 Amazon Batch User Guide.Required: No
Type: Json
Update requires: No interruption
PlatformCapabilities
-
The platform capabilities required by the job definition. If no value is specified, it defaults to
EC2
. Jobs run on Fargate resources specifyFARGATE
.Required: No
Type: Array of String
Update requires: No interruption
-
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.Required: No
Type: Boolean
Update requires: No interruption
RetryStrategy
-
The retry strategy to use for failed jobs that are submitted with this job definition.
Required: No
Type: RetryStrategy
Update requires: No interruption
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.
Required: No
Type: Integer
Update requires: No interruption
-
The tags that are applied to the job definition.
Required: No
Type: Array of
Tag
Update requires: Replacement
Timeout
-
The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Amazon Batch terminates your jobs if they aren't finished.
Required: No
Type: Timeout
Update requires: No interruption
Type
-
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Amazon Batch User Guide.
-
If the value is
container
, then one of the following is required:containerProperties
,ecsProperties
, oreksProperties
. -
If the value is
multinode
, thennodeProperties
is required.
Note
If the job is run on Fargate resources, then
multinode
isn't supported.Required: Yes
Type: String
Allowed values:
container | multinode
Update requires: No interruption
-
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the job definition ARN, such as
arn:aws-cn:batch:us-east-1:111122223333:job-definition/test-gpu:2
.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
Examples
Test nvidia-smi
The following example tests the nvidia-smi
command on a GPU instance
to verify that the GPU is working inside the container. For more information, see
Test
GPU Functionality in the
Amazon Batch User Guide
.
JSON
{ "JobDefinition": { "Type": "AWS::Batch::JobDefinition", "Properties": { "Type": "container", "JobDefinitionName": "nvidia-smi", "ContainerProperties": { "MountPoints": [ { "ReadOnly": false, "SourceVolume": "nvidia", "ContainerPath": "/usr/local/nvidia" } ], "Volumes": [ { "Host": { "SourcePath": "/var/lib/nvidia-docker/volumes/nvidia_driver/latest" }, "Name": "nvidia" } ], "Command": [ "nvidia-smi" ], "Privileged": true, "JobRoleArn": "String", "ReadonlyRootFilesystem": true, "ResourceRequirements": [ { "Type": "MEMORY", "Value": "2000" }, { "Type": "VCPU", "Value": "2" } ], "Image": "nvidia/cuda" } } } }
YAML
JobDefinition: Type: 'AWS::Batch::JobDefinition' Properties: Type: container JobDefinitionName: nvidia-smi ContainerProperties: MountPoints: - ReadOnly: false SourceVolume: nvidia ContainerPath: /usr/local/nvidia Volumes: - Host: SourcePath: /var/lib/nvidia-docker/volumes/nvidia_driver/latest Name: nvidia Command: - nvidia-smi Privileged: true JobRoleArn: String ReadonlyRootFilesystem: true ResourceRequirements: - Type: MEMORY Value: '2000' - Type: VCPU Value: '2' Image: nvidia/cuda
See also
-
Job Definition Parameters in the Amazon Batch User Guide .