Package software.amazon.awscdk.services.sagemaker

Interface CfnCluster.ClusterEbsVolumeConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.ClusterEbsVolumeConfigProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.ClusterEbsVolumeConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sagemaker.*;
 ClusterEbsVolumeConfigProperty clusterEbsVolumeConfigProperty = ClusterEbsVolumeConfigProperty.builder()
         .rootVolume(false)
         .volumeKmsKeyId("volumeKmsKeyId")
         .volumeSizeInGb(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.ClusterEbsVolumeConfigProperty.Builder	A builder for CfnCluster.ClusterEbsVolumeConfigProperty
static final class	CfnCluster.ClusterEbsVolumeConfigProperty.Jsii$Proxy	An implementation for CfnCluster.ClusterEbsVolumeConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.ClusterEbsVolumeConfigProperty.Builder	builder()
default Object	getRootVolume()	Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume.
default String	getVolumeKmsKeyId()	The ID of a KMS key to encrypt the Amazon EBS volume.
default Number	getVolumeSizeInGb()	The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRootVolume

@Stability(Stable)
@Nullable
default Object getRootVolume()

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

getVolumeKmsKeyId

@Stability(Stable)
@Nullable
default String getVolumeKmsKeyId()

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

getVolumeSizeInGb

@Stability(Stable)
@Nullable
default Number getVolumeSizeInGb()

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

builder

@Stability(Stable)
static CfnCluster.ClusterEbsVolumeConfigProperty.Builder builder()

Returns:

a CfnCluster.ClusterEbsVolumeConfigProperty.Builder of CfnCluster.ClusterEbsVolumeConfigProperty