View a markdown version of this page

AWS::SageMaker::ClusterSchedulerConfig - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SageMaker::ClusterSchedulerConfig

Create cluster policy configuration. This policy is used for task prioritization and fair-share allocation of idle compute. This helps prioritize critical workloads and distributes idle compute across entities.

Syntax

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

JSON

{
  "Type" : "AWS::SageMaker::ClusterSchedulerConfig",
  "Properties" : {
      "ClusterArn" : String,
      "Description" : String,
      "Name" : String,
      "SchedulerConfig" : SchedulerConfig,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SageMaker::ClusterSchedulerConfig
Properties:
  ClusterArn: String
  Description: String
  Name: String
  SchedulerConfig: 
    SchedulerConfig
  Tags: 
    - Tag

Properties

ClusterArn

ARN of the cluster.

Required: Yes

Type: String

Pattern: ^arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}$

Maximum: 256

Update requires: Replacement

Description

Property description not available.

Required: No

Type: String

Pattern: ^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}]*$

Maximum: 1024

Update requires: No interruption

Name

Name of the cluster policy.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Minimum: 1

Maximum: 63

Update requires: Replacement

SchedulerConfig

Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

Required: Yes

Type: SchedulerConfig

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ClusterSchedulerConfigArn

ARN of the cluster policy.

ClusterSchedulerConfigId

ID of the cluster policy.

ClusterSchedulerConfigVersion

Version of the cluster policy.

CreationTime

Creation time of the cluster policy.

Status

Status of the cluster policy.