View a markdown version of this page

AWS::SageMaker::Extension - Amazon CloudFormation
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).

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

AWS::SageMaker::Extension

Installs an extension, such as sagemaker-observability, on a SageMaker HyperPod cluster orchestrated by Slurm. The cluster must have NodeProvisioningMode set to Continuous and can have only one extension with a given name. To track the installation, call DescribeClusterExtension.

Syntax

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

JSON

{ "Type" : "AWS::SageMaker::Extension", "Properties" : { "ClusterArn" : String, "ConfigurationValues" : String, "ExtensionName" : String, "ExtensionVersion" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::SageMaker::Extension Properties: ClusterArn: String ConfigurationValues: String ExtensionName: String ExtensionVersion: String Tags: - Tag

Properties

ClusterArn

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the extension is installed.

Required: Yes

Type: String

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

Minimum: 0

Maximum: 256

Update requires: Replacement

ConfigurationValues

The configuration of the extension, as a JSON object serialized as a string. The configuration includes the default value of every setting that you didn't specify.

Required: No

Type: String

Minimum: 1

Maximum: 10240

Update requires: No interruption

ExtensionName

The name of the extension.

Required: Yes

Type: String

Pattern: ^[a-z][a-z0-9-]*$

Minimum: 1

Maximum: 128

Update requires: Replacement

ExtensionVersion

The version of the extension. While SageMaker HyperPod creates or updates the extension, some nodes might still run a different version. To see how many nodes run this version, see NodeSummary.

Required: No

Type: String

Pattern: ^[0-9]+\.[0-9]+\.[0-9]+$

Minimum: 1

Maximum: 64

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

Fn::GetAtt

CreationTime

The time when the extension was created.

ExtensionArn

The Amazon Resource Name (ARN) of the extension.

LastModifiedTime

The time when the extension was last updated.

Status

The status of the extension can be one of the following values:

Creating

SageMaker HyperPod is installing the extension on the cluster's nodes.

Active

The extension runs its current version and configuration on all of the cluster's nodes.

Updating

SageMaker HyperPod is applying a configuration change or version update to the cluster's nodes.

Degraded

The extension runs its current version and configuration on some of the cluster's nodes but not all of them. Or, at least one node recently reported that the extension is unhealthy.

CreateFailed

SageMaker HyperPod couldn't install the extension on any of the cluster's nodes.

UpdateFailed

SageMaker HyperPod couldn't apply the update on any of the cluster's nodes.

Deleting

SageMaker HyperPod is removing the extension from the cluster's nodes.

DeleteFailed

SageMaker HyperPod couldn't remove the extension from any of the cluster's nodes.