interface ClusterEbsVolumeConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.Sagemaker.CfnCluster.ClusterEbsVolumeConfigProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnCluster_ClusterEbsVolumeConfigProperty
Java	software.amazon.awscdk.services.sagemaker.CfnCluster.ClusterEbsVolumeConfigProperty
Python	aws_cdk.aws_sagemaker.CfnCluster.ClusterEbsVolumeConfigProperty
TypeScript	aws-cdk-lib » aws_sagemaker » CfnCluster » ClusterEbsVolumeConfigProperty

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const clusterEbsVolumeConfigProperty: sagemaker.CfnCluster.ClusterEbsVolumeConfigProperty = {
  rootVolume: false,
  volumeKmsKeyId: 'volumeKmsKeyId',
  volumeSizeInGb: 123,
};

Properties

Name	Type	Description
rootVolume?	boolean | IResolvable	Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume.
volumeKmsKeyId?	string	The ID of a KMS key to encrypt the Amazon EBS volume.
volumeSizeInGb?	number	The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group.

---

rootVolume?

Type: boolean | IResolvable (optional)

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 AWS 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 AWS 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 AWS 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 AWS owned KMS key.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html#cfn-sagemaker-cluster-clusterebsvolumeconfig-rootvolume

---

volumeKmsKeyId?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumekmskeyid

---

volumeSizeInGb?

Type: number (optional)

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterebsvolumeconfig.html#cfn-sagemaker-cluster-clusterebsvolumeconfig-volumesizeingb