AWS::Batch::SchedulingPolicy - Amazon CloudFormation
SyntaxPropertiesReturn valuesSee also
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::SchedulingPolicy

The AWS::Batch::SchedulingPolicy resource specifies the parameters for an Amazon Batch scheduling policy. For more information, see Scheduling Policies in the Amazon Batch User Guide.

Syntax

To declare this entity in your Amazon 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

FairsharePolicy

The fair share policy of the scheduling policy.

Required: No

Type: FairsharePolicy

Update requires: No interruption

Name

The name of the 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

Tags

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 Amazon Resources in Amazon General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations.

Required: No

Type: Map of String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the scheduling policy ARN, such as arn:aws-cn:batch:us-east-1:111122223333:scheduling-policy/HighPriority.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

Arn

Returns the scheduling policy ARN, such as arn:aws-cn:batch:us-east-1:111122223333:scheduling-policy/HighPriority.

See also