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

Interface ClusterInstanceGroupDetails.Builder

    • Method Detail

      • currentCount

        ClusterInstanceGroupDetails.Builder currentCount​(Integer currentCount)

        The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

        Parameters:
        currentCount - The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetCount

        ClusterInstanceGroupDetails.Builder targetCount​(Integer targetCount)

        The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

        Parameters:
        targetCount - The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceGroupName

        ClusterInstanceGroupDetails.Builder instanceGroupName​(String instanceGroupName)

        The name of the instance group of a SageMaker HyperPod cluster.

        Parameters:
        instanceGroupName - The name of the instance group of a SageMaker HyperPod cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceType

        ClusterInstanceGroupDetails.Builder instanceType​(String instanceType)

        The instance type of the instance group of a SageMaker HyperPod cluster.

        Parameters:
        instanceType - The instance type of the instance group of a SageMaker HyperPod cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterInstanceType, ClusterInstanceType

      • lifeCycleConfig

        ClusterInstanceGroupDetails.Builder lifeCycleConfig​(ClusterLifeCycleConfig lifeCycleConfig)

        Details of LifeCycle configuration for the instance group.

        Parameters:
        lifeCycleConfig - Details of LifeCycle configuration for the instance group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • executionRole

        ClusterInstanceGroupDetails.Builder executionRole​(String executionRole)

        The execution role for the instance group to assume.

        Parameters:
        executionRole - The execution role for the instance group to assume.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • threadsPerCore

        ClusterInstanceGroupDetails.Builder threadsPerCore​(Integer threadsPerCore)

        The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. 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.

        Parameters:
        threadsPerCore - The number you specified to TreadsPerCore in CreateCluster for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. 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:
        Returns a reference to this object so that method calls can be chained together.

      • instanceStorageConfigs

        ClusterInstanceGroupDetails.Builder instanceStorageConfigs​(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)

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

        Parameters:
        instanceStorageConfigs - The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • instanceStorageConfigs

        ClusterInstanceGroupDetails.Builder instanceStorageConfigs​(ClusterInstanceStorageConfig... instanceStorageConfigs)

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

        Parameters:
        instanceStorageConfigs - The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onStartDeepHealthChecksWithStrings

        ClusterInstanceGroupDetails.Builder onStartDeepHealthChecksWithStrings​(Collection<String> onStartDeepHealthChecks)

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

        Parameters:
        onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onStartDeepHealthChecksWithStrings

        ClusterInstanceGroupDetails.Builder onStartDeepHealthChecksWithStrings​(String... onStartDeepHealthChecks)

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

        Parameters:
        onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onStartDeepHealthChecks

        ClusterInstanceGroupDetails.Builder onStartDeepHealthChecks​(Collection<DeepHealthCheckType> onStartDeepHealthChecks)

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

        Parameters:
        onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • onStartDeepHealthChecks

        ClusterInstanceGroupDetails.Builder onStartDeepHealthChecks​(DeepHealthCheckType... onStartDeepHealthChecks)

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

        Parameters:
        onStartDeepHealthChecks - A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • status

        ClusterInstanceGroupDetails.Builder status​(String status)

        The current status of the cluster instance group.

        • InService: The instance group is active and healthy.

        • Creating: The instance group is being provisioned.

        • Updating: The instance group is being updated.

        • Failed: The instance group has failed to provision or is no longer healthy.

        • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

        • Deleting: The instance group is being deleted.

        Parameters:
        status - The current status of the cluster instance group.

        • InService: The instance group is active and healthy.

        • Creating: The instance group is being provisioned.

        • Updating: The instance group is being updated.

        • Failed: The instance group has failed to provision or is no longer healthy.

        • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

        • Deleting: The instance group is being deleted.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceGroupStatus, InstanceGroupStatus

      • status

        ClusterInstanceGroupDetails.Builder status​(InstanceGroupStatus status)

        The current status of the cluster instance group.

        • InService: The instance group is active and healthy.

        • Creating: The instance group is being provisioned.

        • Updating: The instance group is being updated.

        • Failed: The instance group has failed to provision or is no longer healthy.

        • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

        • Deleting: The instance group is being deleted.

        Parameters:
        status - The current status of the cluster instance group.

        • InService: The instance group is active and healthy.

        • Creating: The instance group is being provisioned.

        • Updating: The instance group is being updated.

        • Failed: The instance group has failed to provision or is no longer healthy.

        • Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

        • Deleting: The instance group is being deleted.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        InstanceGroupStatus, InstanceGroupStatus

      • trainingPlanArn

        ClusterInstanceGroupDetails.Builder trainingPlanArn​(String trainingPlanArn)

        The Amazon Resource Name (ARN); of the training plan associated with 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 .

        Parameters:
        trainingPlanArn - The Amazon Resource Name (ARN); of the training plan associated with 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:
        Returns a reference to this object so that method calls can be chained together.

      • trainingPlanStatus

        ClusterInstanceGroupDetails.Builder trainingPlanStatus​(String trainingPlanStatus)

        The current status of the training plan associated with this cluster instance group.

        Parameters:
        trainingPlanStatus - The current status of the training plan associated with this cluster instance group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • overrideVpcConfig

        ClusterInstanceGroupDetails.Builder overrideVpcConfig​(VpcConfig overrideVpcConfig)

        The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

        Parameters:
        overrideVpcConfig - The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.