AWS::Deadline::QueueEnvironment - Amazon CloudFormation
SyntaxPropertiesReturn values
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::Deadline::QueueEnvironment

Creates an environment for a queue that defines how jobs in the queue run.

Syntax

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

JSON

{
  "Type" : "AWS::Deadline::QueueEnvironment",
  "Properties" : {
      "FarmId" : String,
      "Priority" : Integer,
      "QueueId" : String,
      "Template" : String,
      "TemplateType" : String
    }
}

YAML

Type: AWS::Deadline::QueueEnvironment
Properties:
  FarmId: String
  Priority: Integer
  QueueId: String
  Template: String
  TemplateType: String

Properties

FarmId

The identifier assigned to the farm that contains the queue.

Required: Yes

Type: String

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

Update requires: Replacement

Priority

The queue environment's priority.

Required: Yes

Type: Integer

Minimum: 0

Maximum: 10000

Update requires: No interruption

QueueId

The unique identifier of the queue that contains the environment.

Required: Yes

Type: String

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

Update requires: Replacement

Template

A JSON or YAML template the describes the processing environment for the queue.

Required: Yes

Type: String

Minimum: 1

Maximum: 15000

Update requires: No interruption

TemplateType

Specifies whether the template for the queue environment is JSON or YAML.

Required: Yes

Type: String

Allowed values: JSON | YAML

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns a reference to a queue environment object.

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.

Name

The name of the queue environment.

QueueEnvironmentId

The queue environment ID.