AWS::Batch::JobQueue JobStateTimeLimitAction - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Batch::JobQueue JobStateTimeLimitAction

Specifies an action that Amazon Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

Syntax

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

JSON

{
  "Action" : String,
  "MaxTimeSeconds" : Integer,
  "Reason" : String,
  "State" : String
}

YAML

  Action: String
  MaxTimeSeconds: Integer
  Reason: String
  State: String

Properties

Action

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL, which will cancel the job.

Required: Yes

Type: String

Allowed values: CANCEL

Update requires: No interruption

MaxTimeSeconds

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

Required: Yes

Type: Integer

Minimum: 600

Maximum: 86400

Update requires: No interruption

Reason

The reason to log for the action being taken.

Required: Yes

Type: String

Update requires: No interruption

State

The state of the job needed to trigger the action. The only supported value is RUNNABLE.

Required: Yes

Type: String

Allowed values: RUNNABLE

Update requires: No interruption