AWS::SageMaker::Cluster ClusterEbsVolumeConfig - Amazon CloudFormation
SyntaxProperties
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::Cluster ClusterEbsVolumeConfig

Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.

Syntax

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

JSON

{
  "RootVolume" : Boolean,
  "VolumeKmsKeyId" : String,
  "VolumeSizeInGB" : Integer
}

YAML

  RootVolume: Boolean
  VolumeKmsKeyId: String
  VolumeSizeInGB: Integer

Properties

RootVolume

Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig fields to configure both the root and secondary volumes. Set the value to True if you'd like to provide your own customer managed Amazon KMS key to encrypt the root volume. When True:

  • The configuration is applied to the root volume.

  • You can't specify the VolumeSizeInGB field. The size of the root volume is determined for you.

  • You must specify a KMS key ID for VolumeKmsKeyId to encrypt the root volume with your own KMS key instead of an Amazon owned KMS key.

Otherwise, by default, the value is False, and the following applies:

  • The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon owned key.

  • You must specify the VolumeSizeInGB field.

  • You can optionally specify the VolumeKmsKeyId to encrypt the secondary volume with your own KMS key instead of an Amazon owned KMS key.

Required: No

Type: Boolean

Update requires: No interruption

VolumeKmsKeyId

The ID of a KMS key to encrypt the Amazon EBS volume.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9:/_-]*$

Minimum: 0

Maximum: 2048

Update requires: No interruption

VolumeSizeInGB

The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.

Required: No

Type: Integer

Minimum: 1

Maximum: 16384

Update requires: No interruption