Interface ClusterInstanceGroupDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>, SdkBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>, SdkPojo
Enclosing class:
ClusterInstanceGroupDetails
@Mutable @NotThreadSafe public static interface ClusterInstanceGroupDetails.Builder extends SdkPojo, CopyableBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>

  • Method Details

    • 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.

    • minCount

      ClusterInstanceGroupDetails.Builder minCount(Integer minCount)

      The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.

      Parameters:
      minCount - The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.
      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:

    • instanceType

      ClusterInstanceGroupDetails.Builder instanceType(ClusterInstanceType 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:

    • 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.

    • lifeCycleConfig

      default ClusterInstanceGroupDetails.Builder lifeCycleConfig(Consumer<ClusterLifeCycleConfig.Builder> lifeCycleConfig)

      Details of LifeCycle configuration for the instance group.

      This is a convenience method that creates an instance of the ClusterLifeCycleConfig.Builder avoiding the need to create one manually via ClusterLifeCycleConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifeCycleConfig(ClusterLifeCycleConfig).

      Parameters:
      lifeCycleConfig - a consumer that will call methods on ClusterLifeCycleConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.

    • instanceStorageConfigs

      ClusterInstanceGroupDetails.Builder instanceStorageConfigs(Consumer<ClusterInstanceStorageConfig.Builder>... instanceStorageConfigs)

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

      This is a convenience method that creates an instance of the ClusterInstanceStorageConfig.Builder avoiding the need to create one manually via ClusterInstanceStorageConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceStorageConfigs(List<ClusterInstanceStorageConfig>).

      Parameters:
      instanceStorageConfigs - a consumer that will call methods on ClusterInstanceStorageConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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:

    • 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:

    • 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.

    • overrideVpcConfig

      default ClusterInstanceGroupDetails.Builder overrideVpcConfig(Consumer<VpcConfig.Builder> overrideVpcConfig)

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

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrideVpcConfig(VpcConfig).

      Parameters:
      overrideVpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduledUpdateConfig

      ClusterInstanceGroupDetails.Builder scheduledUpdateConfig(ScheduledUpdateConfig scheduledUpdateConfig)

      The configuration object of the schedule that SageMaker follows when updating the AMI.

      Parameters:
      scheduledUpdateConfig - The configuration object of the schedule that SageMaker follows when updating the AMI.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduledUpdateConfig

      default ClusterInstanceGroupDetails.Builder scheduledUpdateConfig(Consumer<ScheduledUpdateConfig.Builder> scheduledUpdateConfig)

      The configuration object of the schedule that SageMaker follows when updating the AMI.

      This is a convenience method that creates an instance of the ScheduledUpdateConfig.Builder avoiding the need to create one manually via ScheduledUpdateConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scheduledUpdateConfig(ScheduledUpdateConfig).

      Parameters:
      scheduledUpdateConfig - a consumer that will call methods on ScheduledUpdateConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • currentImageId

      ClusterInstanceGroupDetails.Builder currentImageId(String currentImageId)

      The ID of the Amazon Machine Image (AMI) currently in use by the instance group.

      Parameters:
      currentImageId - The ID of the Amazon Machine Image (AMI) currently in use by the instance group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • desiredImageId

      ClusterInstanceGroupDetails.Builder desiredImageId(String desiredImageId)

      The ID of the Amazon Machine Image (AMI) desired for the instance group.

      Parameters:
      desiredImageId - The ID of the Amazon Machine Image (AMI) desired for the instance group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeOperationsWithStrings

      ClusterInstanceGroupDetails.Builder activeOperationsWithStrings(Map<String,Integer> activeOperations)

      A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.

      Parameters:
      activeOperations - A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeOperations

      ClusterInstanceGroupDetails.Builder activeOperations(Map<ActiveClusterOperationName,Integer> activeOperations)

      A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.

      Parameters:
      activeOperations - A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kubernetesConfig

      ClusterInstanceGroupDetails.Builder kubernetesConfig(ClusterKubernetesConfigDetails kubernetesConfig)

      The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.

      Parameters:
      kubernetesConfig - The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kubernetesConfig

      default ClusterInstanceGroupDetails.Builder kubernetesConfig(Consumer<ClusterKubernetesConfigDetails.Builder> kubernetesConfig)

      The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.

      This is a convenience method that creates an instance of the ClusterKubernetesConfigDetails.Builder avoiding the need to create one manually via ClusterKubernetesConfigDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kubernetesConfig(ClusterKubernetesConfigDetails).

      Parameters:
      kubernetesConfig - a consumer that will call methods on ClusterKubernetesConfigDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • capacityRequirements

      ClusterInstanceGroupDetails.Builder capacityRequirements(ClusterCapacityRequirements capacityRequirements)

      The instance capacity requirements for the instance group.

      Parameters:
      capacityRequirements - The instance capacity requirements for the instance group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityRequirements

      default ClusterInstanceGroupDetails.Builder capacityRequirements(Consumer<ClusterCapacityRequirements.Builder> capacityRequirements)

      The instance capacity requirements for the instance group.

      This is a convenience method that creates an instance of the ClusterCapacityRequirements.Builder avoiding the need to create one manually via ClusterCapacityRequirements.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityRequirements(ClusterCapacityRequirements).

      Parameters:
      capacityRequirements - a consumer that will call methods on ClusterCapacityRequirements.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetStateCount

      ClusterInstanceGroupDetails.Builder targetStateCount(Integer targetStateCount)

      Represents the number of running nodes using the desired Image ID.

      1. During software update operations: This count shows the number of nodes running on the desired Image ID. If a rollback occurs, the current image ID and desired image ID (both included in the describe cluster response) swap values. The TargetStateCount then shows the number of nodes running on the newly designated desired image ID (which was previously the current image ID).

      2. During simultaneous scaling and software update operations: This count shows the number of instances running on the desired image ID, including any new instances created as part of the scaling request. New nodes are always created using the desired image ID, so TargetStateCount reflects the total count of nodes running on the desired image ID, even during rollback scenarios.

      Parameters:
      targetStateCount - Represents the number of running nodes using the desired Image ID.

      1. During software update operations: This count shows the number of nodes running on the desired Image ID. If a rollback occurs, the current image ID and desired image ID (both included in the describe cluster response) swap values. The TargetStateCount then shows the number of nodes running on the newly designated desired image ID (which was previously the current image ID).

      2. During simultaneous scaling and software update operations: This count shows the number of instances running on the desired image ID, including any new instances created as part of the scaling request. New nodes are always created using the desired image ID, so TargetStateCount reflects the total count of nodes running on the desired image ID, even during rollback scenarios.

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

    • softwareUpdateStatus

      ClusterInstanceGroupDetails.Builder softwareUpdateStatus(String softwareUpdateStatus)

      Status of the last software udpate request.

      Status transitions follow these possible sequences:

      • Pending -> InProgress -> Succeeded

      • Pending -> InProgress -> RollbackInProgress -> RollbackComplete

      • Pending -> InProgress -> RollbackInProgress -> Failed

      Parameters:
      softwareUpdateStatus - Status of the last software udpate request.

      Status transitions follow these possible sequences:

      • Pending -> InProgress -> Succeeded

      • Pending -> InProgress -> RollbackInProgress -> RollbackComplete

      • Pending -> InProgress -> RollbackInProgress -> Failed

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

    • softwareUpdateStatus

      ClusterInstanceGroupDetails.Builder softwareUpdateStatus(SoftwareUpdateStatus softwareUpdateStatus)

      Status of the last software udpate request.

      Status transitions follow these possible sequences:

      • Pending -> InProgress -> Succeeded

      • Pending -> InProgress -> RollbackInProgress -> RollbackComplete

      • Pending -> InProgress -> RollbackInProgress -> Failed

      Parameters:
      softwareUpdateStatus - Status of the last software udpate request.

      Status transitions follow these possible sequences:

      • Pending -> InProgress -> Succeeded

      • Pending -> InProgress -> RollbackInProgress -> RollbackComplete

      • Pending -> InProgress -> RollbackInProgress -> Failed

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

    • activeSoftwareUpdateConfig

      ClusterInstanceGroupDetails.Builder activeSoftwareUpdateConfig(DeploymentConfiguration activeSoftwareUpdateConfig)
      Sets the value of the ActiveSoftwareUpdateConfig property for this object.
      Parameters:
      activeSoftwareUpdateConfig - The new value for the ActiveSoftwareUpdateConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeSoftwareUpdateConfig

      default ClusterInstanceGroupDetails.Builder activeSoftwareUpdateConfig(Consumer<DeploymentConfiguration.Builder> activeSoftwareUpdateConfig)
      Sets the value of the ActiveSoftwareUpdateConfig property for this object. This is a convenience method that creates an instance of the DeploymentConfiguration.Builder avoiding the need to create one manually via DeploymentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to activeSoftwareUpdateConfig(DeploymentConfiguration).

      Parameters:
      activeSoftwareUpdateConfig - a consumer that will call methods on DeploymentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: