Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.Builder

java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty>
Enclosing interface:
CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty
@Stability(Stable) public static final class CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty>
A builder for CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • rootVolume

      @Stability(Stable) public CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.Builder rootVolume(Boolean rootVolume)
      Sets the value of CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.getRootVolume()
      Parameters:
      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 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.
      Returns:
      this

    • rootVolume

      @Stability(Stable) public CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.Builder rootVolume(IResolvable rootVolume)
      Sets the value of CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.getRootVolume()
      Parameters:
      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 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.
      Returns:
      this

    • volumeKmsKeyId

      @Stability(Stable) public CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.Builder volumeKmsKeyId(String volumeKmsKeyId)
      Sets the value of CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.getVolumeKmsKeyId()
      Parameters:
      volumeKmsKeyId - The ID of a KMS key to encrypt the Amazon EBS volume.
      Returns:
      this

    • volumeSizeInGb

      @Stability(Stable) public CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.Builder volumeSizeInGb(Number volumeSizeInGb)
      Sets the value of CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty.getVolumeSizeInGb()
      Parameters:
      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 .
      Returns:
      this

    • build

      @Stability(Stable) public CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty>
      Returns:
      a new instance of CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty
      Throws:
      NullPointerException - if any required attribute was not provided