Skip to content

/AWS1/CL_SGMCLUSTEBSVOLUMECFG

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_volumesizeingb TYPE /AWS1/SGMCLUSTEBSVOLSIZEINGB /AWS1/SGMCLUSTEBSVOLSIZEINGB

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.

iv_volumekmskeyid TYPE /AWS1/SGMKMSKEYID /AWS1/SGMKMSKEYID

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

iv_rootvolume TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

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

Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_VOLUMESIZEINGB() Getter for VOLUMESIZEINGB, with configurable default
ASK_VOLUMESIZEINGB() Getter for VOLUMESIZEINGB w/ exceptions if field has no valu
HAS_VOLUMESIZEINGB() Determine if VOLUMESIZEINGB has a value

VolumeKmsKeyId

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

Accessible with the following methods

Method Description
GET_VOLUMEKMSKEYID() Getter for VOLUMEKMSKEYID, with configurable default
ASK_VOLUMEKMSKEYID() Getter for VOLUMEKMSKEYID w/ exceptions if field has no valu
HAS_VOLUMEKMSKEYID() Determine if VOLUMEKMSKEYID has a value

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

Accessible with the following methods

Method Description
GET_ROOTVOLUME() Getter for ROOTVOLUME, with configurable default
ASK_ROOTVOLUME() Getter for ROOTVOLUME w/ exceptions if field has no value
HAS_ROOTVOLUME() Determine if ROOTVOLUME has a value