Package software.amazon.awssdk.services.sagemaker.model

Class CreateClusterRequest

    • Method Detail

      • clusterName

        public final String clusterName()

        The name for the new SageMaker HyperPod cluster.

        Returns:
        The name for the new SageMaker HyperPod cluster.

      • hasInstanceGroups

        public final boolean hasInstanceGroups()
        For responses, this returns true if the service returned a value for the InstanceGroups 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.

      • instanceGroups

        public final List<ClusterInstanceGroupSpecification> instanceGroups()

        The instance groups to be created in the SageMaker HyperPod cluster.

        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 hasInstanceGroups() method.

        Returns:
        The instance groups to be created in the SageMaker HyperPod cluster.

      • hasRestrictedInstanceGroups

        public final boolean hasRestrictedInstanceGroups()
        For responses, this returns true if the service returned a value for the RestrictedInstanceGroups 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.

      • restrictedInstanceGroups

        public final List<ClusterRestrictedInstanceGroupSpecification> restrictedInstanceGroups()

        The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

        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 hasRestrictedInstanceGroups() method.

        Returns:
        The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.

      • vpcConfig

        public final VpcConfig vpcConfig()

        Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

        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:
        Specifies the Amazon Virtual Private Cloud (VPC) that is associated with the Amazon SageMaker HyperPod cluster. You can control access to and from your resources by configuring your VPC. For more information, see Give SageMaker access to resources in your Amazon VPC.

        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:

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final List<Tag> tags()

        Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

        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 hasTags() method.

        Returns:
        Custom tags for managing the SageMaker HyperPod cluster as an Amazon Web Services resource. You can add tags to your cluster in the same way you add them in other Amazon Web Services services that support tagging. To learn more about tagging Amazon Web Services resources in general, see Tagging Amazon Web Services Resources User Guide.

      • orchestrator

        public final ClusterOrchestrator orchestrator()

        The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is "eks", which is to use an Amazon Elastic Kubernetes Service cluster as the orchestrator.

        Returns:
        The type of orchestrator to use for the SageMaker HyperPod cluster. Currently, the only supported value is "eks", which is to use an Amazon Elastic Kubernetes Service cluster as the orchestrator.

      • nodeRecovery

        public final ClusterNodeRecovery nodeRecovery()

        The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

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

        Returns:
        The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.
        See Also:
        ClusterNodeRecovery

      • nodeRecoveryAsString

        public final String nodeRecoveryAsString()

        The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.

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

        Returns:
        The node recovery mode for the SageMaker HyperPod cluster. When set to Automatic, SageMaker HyperPod will automatically reboot or replace faulty nodes when issues are detected. When set to None, cluster administrators will need to manually manage any faulty cluster instances.
        See Also:
        ClusterNodeRecovery

      • tieredStorageConfig

        public final ClusterTieredStorageConfig tieredStorageConfig()

        The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

        Returns:
        The configuration for managed tier checkpointing on the HyperPod cluster. When enabled, this feature uses a multi-tier storage approach for storing model checkpoints, providing faster checkpoint operations and improved fault tolerance across cluster nodes.

      • nodeProvisioningMode

        public final ClusterNodeProvisioningMode nodeProvisioningMode()

        The mode for provisioning nodes in the cluster. You can specify the following modes:

        • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

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

        Returns:
        The mode for provisioning nodes in the cluster. You can specify the following modes:

        • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

        See Also:
        ClusterNodeProvisioningMode

      • nodeProvisioningModeAsString

        public final String nodeProvisioningModeAsString()

        The mode for provisioning nodes in the cluster. You can specify the following modes:

        • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

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

        Returns:
        The mode for provisioning nodes in the cluster. You can specify the following modes:

        • Continuous: Scaling behavior that enables 1) concurrent operation execution within instance groups, 2) continuous retry mechanisms for failed operations, 3) enhanced customer visibility into cluster events through detailed event streams, 4) partial provisioning capabilities. Your clusters and instance groups remain InService while scaling. This mode is only supported for EKS orchestrated clusters.

        See Also:
        ClusterNodeProvisioningMode

      • clusterRole

        public final String clusterRole()

        The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.

        Returns:
        The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes to perform cluster autoscaling operations. This role must have permissions for sagemaker:BatchAddClusterNodes and sagemaker:BatchDeleteClusterNodes. This is only required when autoscaling is enabled and when HyperPod is performing autoscaling operations.

      • autoScaling

        public final ClusterAutoScalingConfig autoScaling()

        The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

        Returns:
        The autoscaling configuration for the cluster. Enables automatic scaling of cluster nodes based on workload demand using a Karpenter-based system.

      • 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