Interface ClusterInstanceGroupDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>, SdkBuilder<ClusterInstanceGroupDetails.Builder,ClusterInstanceGroupDetails>, SdkPojo
Enclosing class:
ClusterInstanceGroupDetails
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.

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