Class ClusterInstanceGroupSpecification

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ClusterInstanceGroupSpecification
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClusterInstanceGroupSpecification.Builder,ClusterInstanceGroupSpecification>
@Generated("software.amazon.awssdk:codegen") public final class ClusterInstanceGroupSpecification extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClusterInstanceGroupSpecification.Builder,ClusterInstanceGroupSpecification>

The specifications of an instance group that you need to define.

See Also:

  • Method Details

    • instanceCount

      public final Integer instanceCount()

      Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

      Returns:
      Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

    • instanceGroupName

      public final String instanceGroupName()

      Specifies the name of the instance group.

      Returns:
      Specifies the name of the instance group.

    • instanceType

      public final ClusterInstanceType instanceType()

      Specifies the instance type of the instance group.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ClusterInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      Specifies the instance type of the instance group.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      Specifies the instance type of the instance group.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return ClusterInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      Specifies the instance type of the instance group.
      See Also:

    • lifeCycleConfig

      public final ClusterLifeCycleConfig lifeCycleConfig()

      Specifies the LifeCycle configuration for the instance group.

      Returns:
      Specifies the LifeCycle configuration for the instance group.

    • executionRole

      public final String executionRole()

      Specifies an IAM execution role to be assumed by the instance group.

      Returns:
      Specifies an IAM execution role to be assumed by the instance group.

    • threadsPerCore

      public final Integer threadsPerCore()

      Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

      Returns:
      Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.

    • hasInstanceStorageConfigs

      public final boolean hasInstanceStorageConfigs()
      For responses, this returns true if the service returned a value for the InstanceStorageConfigs property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • instanceStorageConfigs

      public final List<ClusterInstanceStorageConfig> instanceStorageConfigs()

      Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceStorageConfigs() method.

      Returns:
      Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

    • onStartDeepHealthChecks

      public final List<DeepHealthCheckType> onStartDeepHealthChecks()

      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOnStartDeepHealthChecks() method.

      Returns:
      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

    • hasOnStartDeepHealthChecks

      public final boolean hasOnStartDeepHealthChecks()
      For responses, this returns true if the service returned a value for the OnStartDeepHealthChecks property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • onStartDeepHealthChecksAsStrings

      public final List<String> onStartDeepHealthChecksAsStrings()

      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOnStartDeepHealthChecks() method.

      Returns:
      A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

    • trainingPlanArn

      public final String trainingPlanArn()

      The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

      Returns:
      The Amazon Resource Name (ARN); of the training plan to use for this cluster instance group.

      For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

    • overrideVpcConfig

      public final VpcConfig overrideVpcConfig()

      To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

      When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

      • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

      • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

      Additional resources for IPv6 configuration:

      Returns:
      To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

      When your Amazon VPC and subnets support IPv6, network communications differ based on the cluster orchestration platform:

      • Slurm-orchestrated clusters automatically configure nodes with dual IPv6 and IPv4 addresses, allowing immediate IPv6 network communications.

      • In Amazon EKS-orchestrated clusters, nodes receive dual-stack addressing, but pods can only use IPv6 when the Amazon EKS cluster is explicitly IPv6-enabled. For information about deploying an IPv6 Amazon EKS cluster, see Amazon EKS IPv6 Cluster Deployment.

      Additional resources for IPv6 configuration:

    • scheduledUpdateConfig

      public final ScheduledUpdateConfig scheduledUpdateConfig()

      The configuration object of the schedule that SageMaker uses to update the AMI.

      Returns:
      The configuration object of the schedule that SageMaker uses to update the AMI.

    • imageId

      public final String imageId()

      When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

      • HyperPodPublicAmiId: Use a HyperPod public AMI

      • CustomAmiId: Use your custom AMI

      • default: Use the default latest system image

      If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

      • Encryption: The custom AMI must be unencrypted.

      • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

      • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

      When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

      Returns:
      When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

      • HyperPodPublicAmiId: Use a HyperPod public AMI

      • CustomAmiId: Use your custom AMI

      • default: Use the default latest system image

      If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

      • Encryption: The custom AMI must be unencrypted.

      • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

      • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

      When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

    • toBuilder

      public ClusterInstanceGroupSpecification.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClusterInstanceGroupSpecification.Builder,ClusterInstanceGroupSpecification>
      Returns:
      a builder for type T

    • builder

      public static ClusterInstanceGroupSpecification.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClusterInstanceGroupSpecification.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.