AWS::Batch::JobDefinition

Batch JobDefinition

Resource Type definition for AWS::Batch::JobDefinition

Properties

15 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`Type`	`string`	Required
`ConsumableResourceProperties`	`ConsumableResourceProperties`
`ContainerProperties`	`ContainerProperties`
`EcsProperties`	`EcsProperties`
`EksProperties`	`EksProperties`
`JobDefinitionName`	`string`	Create-only
`NodeProperties`	`NodeProperties`
`Parameters`	`object`
`PlatformCapabilities`	`Array<string>`
`PropagateTags`	`boolean`
`ResourceRetentionPolicy`	`ResourceRetentionPolicy`	Write-only
`RetryStrategy`	`RetryStrategy`
`SchedulingPriority`	`integer`
`Tags`	`object`
`Timeout`	`JobTimeout`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`JobDefinitionArn`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Batch::JobDefinition

Resources:
  MyResource:
    Type: AWS::Batch::JobDefinition
    Properties:
      Type: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

Batch:RegisterJobDefinitionBatch:TagResourceBatch:DescribeJobDefinitionsIam:PassRole

read

Batch:DescribeJobDefinitions

update

Batch:DescribeJobDefinitionsBatch:RegisterJobDefinitionBatch:DeregisterJobDefinitionBatch:TagResourceBatch:UntagResourceIam:PassRole

delete

Batch:DescribeJobDefinitionsBatch:DeregisterJobDefinitionIam:PassRole

list

Batch:DescribeJobDefinitions

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceBatch

Properties16

Required1

TaggingSupported

Primary IDJobDefinitionName

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

JobDefinitionName

Related Resources

External Links

AWS Documentation