View a markdown version of this page

AWS::Deadline::Job - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Deadline::Job

Creates a job. A job is a set of instructions that Deadline Cloud uses to schedule and run work on available workers. For more information, see Deadline Cloud jobs.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Deadline::Job",
  "Properties" : {
      "FarmId" : String,
      "MaxFailedTasksCount" : Integer,
      "MaxRetriesPerTask" : Integer,
      "MaxWorkerCount" : Integer,
      "Priority" : Integer,
      "QueueId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Deadline::Job
Properties:
  FarmId: String
  MaxFailedTasksCount: Integer
  MaxRetriesPerTask: Integer
  MaxWorkerCount: Integer
  Priority: Integer
  QueueId: String
  Tags: 
    - Tag

Properties

FarmId

The farm ID of the job.

Required: No

Type: String

Pattern: ^farm-[0-9a-f]{32}$

Update requires: Replacement

MaxFailedTasksCount

The number of task failures before the job stops running and is marked as FAILED.

Required: No

Type: Integer

Minimum: 0

Maximum: 2147483647

Update requires: Replacement

MaxRetriesPerTask

The maximum number of retries per failed tasks.

Required: No

Type: Integer

Minimum: 0

Maximum: 2147483647

Update requires: Replacement

MaxWorkerCount

The maximum number of worker hosts that can concurrently process a job.

Required: No

Type: Integer

Minimum: -1

Maximum: 2147483647

Update requires: Replacement

Priority

The job priority.

Required: No

Type: Integer

Minimum: 0

Maximum: 100

Update requires: Replacement

QueueId

The queue ID of the job.

Required: No

Type: String

Pattern: ^queue-[0-9a-f]{32}$

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreatedAt

The date and time the resource was created.

CreatedBy

The user or system that created this resource.

JobId

The job ID.

LifecycleStatus

The life cycle status of the job.

LifecycleStatusMessage

A message that communicates the status of the life cycle.

Name

The name of the job.

TaskRunStatus

The task run status for the job.