The AWS::Batch::SchedulingPolicy resource specifies the parameters for an
AWS Batch scheduling policy. For more information, see Scheduling
Policies in the
AWS Batch User Guide
.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Batch::SchedulingPolicy",
"Properties" : {
"FairsharePolicy" : FairsharePolicy,
"Name" : String,
"Tags" : {Key: Value, ...}
}
}
YAML
Type: AWS::Batch::SchedulingPolicy
Properties:
FairsharePolicy:
FairsharePolicy
Name: String
Tags:
Key: Value
Properties
-
The fair-share scheduling policy details.
Required: No
Type: FairsharePolicy
Update requires: No interruption
Name-
The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Required: No
Type: String
Update requires: Replacement
-
The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging AWS Resources in AWS General Reference.
These tags can be updated or removed using the TagResource and UntagResource API operations.
Required: No
Type: Object of String
Pattern:
.*Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the scheduling policy ARN, such as arn:aws:batch:us-east-1:111122223333:scheduling-policy/HighPriority.
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.
Arn-
Returns the scheduling policy ARN, such as
arn:aws:batch:us-east-1:111122223333:scheduling-policy/HighPriority.
See also
-
Scheduling Policy Parameters in the AWS Batch User Guide .
