Package software.amazon.awscdk.services.sagemaker

Interface CfnCluster.ClusterInstanceStorageConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.ClusterInstanceStorageConfigProperty.Jsii$Proxy

Enclosing class:

CfnCluster

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

Defines the configuration for attaching additional storage to the instances in 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.*;
 ClusterInstanceStorageConfigProperty clusterInstanceStorageConfigProperty = ClusterInstanceStorageConfigProperty.builder()
         .ebsVolumeConfig(ClusterEbsVolumeConfigProperty.builder()
                 .rootVolume(false)
                 .volumeKmsKeyId("volumeKmsKeyId")
                 .volumeSizeInGb(123)
                 .build())
         .fsxLustreConfig(ClusterFsxLustreConfigProperty.builder()
                 .dnsName("dnsName")
                 .mountName("mountName")
                 // the properties below are optional
                 .mountPath("mountPath")
                 .build())
         .fsxOpenZfsConfig(ClusterFsxOpenZfsConfigProperty.builder()
                 .dnsName("dnsName")
                 // the properties below are optional
                 .mountPath("mountPath")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCluster.ClusterInstanceStorageConfigProperty.Builder	builder()
default Object	getEbsVolumeConfig()	Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group.
default Object	getFsxLustreConfig()	Configuration for mounting an Amazon FSx Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
default Object	getFsxOpenZfsConfig()	Configuration for mounting an Amazon FSx OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEbsVolumeConfig

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

Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes 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 .

Returns union: either IResolvable or CfnCluster.ClusterEbsVolumeConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html#cfn-sagemaker-cluster-clusterinstancestorageconfig-ebsvolumeconfig

getFsxLustreConfig

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

Configuration for mounting an Amazon FSx Lustre file system to the instances in the SageMaker HyperPod cluster instance group.

Returns union: either IResolvable or CfnCluster.ClusterFsxLustreConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html#cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxlustreconfig

getFsxOpenZfsConfig

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

Configuration for mounting an Amazon FSx OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.

Returns union: either IResolvable or CfnCluster.ClusterFsxOpenZfsConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancestorageconfig.html#cfn-sagemaker-cluster-clusterinstancestorageconfig-fsxopenzfsconfig

builder

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

Returns:

a CfnCluster.ClusterInstanceStorageConfigProperty.Builder of CfnCluster.ClusterInstanceStorageConfigProperty