AWS::SageMaker::ComputeQuota - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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::ComputeQuota

Create compute allocation definition. This defines how compute is allocated, shared, and borrowed for specified entities. Specifically, how to lend and borrow idle compute and assign a fair-share weight to the specified entities.

Syntax

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

JSON

{
  "Type" : "AWS::SageMaker::ComputeQuota",
  "Properties" : {
      "ActivationState" : String,
      "ClusterArn" : String,
      "ComputeQuotaConfig" : ComputeQuotaConfig,
      "ComputeQuotaTarget" : ComputeQuotaTarget,
      "Description" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SageMaker::ComputeQuota
Properties:
  ActivationState: String
  ClusterArn: String
  ComputeQuotaConfig: 
    ComputeQuotaConfig
  ComputeQuotaTarget: 
    ComputeQuotaTarget
  Description: String
  Name: String
  Tags: 
    - Tag

Properties

ActivationState

The state of the compute allocation being described. Use to enable or disable compute allocation.

Default is Enabled.

Required: No

Type: String

Allowed values: Enabled | Disabled

Update requires: No interruption

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}$

Minimum: 20

Maximum: 256

Update requires: Replacement

ComputeQuotaConfig

Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.

Required: Yes

Type: ComputeQuotaConfig

Update requires: No interruption

ComputeQuotaTarget

The target entity to allocate compute resources to.

Required: Yes

Type: ComputeQuotaTarget

Update requires: No interruption

Description

Property description not available.

Required: No

Type: String

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

Minimum: 0

Maximum: 1024

Update requires: No interruption

Name

Name of the compute allocation definition.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 63

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: Array of Tag

Minimum: 0

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ComputeQuotaArn

ARN of the compute allocation definition.

ComputeQuotaId

ID of the compute allocation definition.

ComputeQuotaVersion

Version of the compute allocation definition.

CreationTime

Creation time of the compute allocation definition.

LastModifiedTime

Last modified time of the compute allocation definition.

Status

Status of the compute allocation definition.