Creates a limit that manages the distribution of shared resources, such as floating licenses. A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.
You must add the amountRequirementName to a step in a job template to
declare the limit requirement.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Deadline::Limit",
"Properties" : {
"AmountRequirementName" : String,
"Description" : String,
"DisplayName" : String,
"FarmId" : String,
"MaxCount" : Integer
}
}
YAML
Type: AWS::Deadline::Limit
Properties:
AmountRequirementName: String
Description: String
DisplayName: String
FarmId: String
MaxCount: Integer
Properties
AmountRequirementName-
The value that you specify as the
namein theamountsfield of thehostRequirementsin a step of a job template to declare the limit requirement.Required: Yes
Type: String
Maximum:
1024Update requires: Replacement
Description-
A description of the limit. A clear description helps you identify the purpose of the limit.
Important
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Required: No
Type: String
Minimum:
0Maximum:
100Update requires: No interruption
DisplayName-
The name of the limit used in lists to identify the limit.
Important
This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
Required: Yes
Type: String
Minimum:
1Maximum:
100Update requires: No interruption
FarmId-
The unique identifier of the farm that contains the limit.
Required: Yes
Type: String
Pattern:
^farm-[0-9a-f]{32}$Update requires: Replacement
MaxCount-
The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.
The
maxValuemust not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.Required: Yes
Type: Integer
Minimum:
-1Maximum:
2147483647Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier of the limit.
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.
CurrentCount-
The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.
LimitId-
The unique identifier of the limit.
