Interface ClusterRestrictedInstanceGroupDetails.Builder

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

  • Method Details

    • currentCount

      ClusterRestrictedInstanceGroupDetails.Builder currentCount(Integer currentCount)

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

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

    • targetCount

      ClusterRestrictedInstanceGroupDetails.Builder targetCount(Integer targetCount)

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

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

    • instanceGroupName

      ClusterRestrictedInstanceGroupDetails.Builder instanceGroupName(String instanceGroupName)

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

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

    • instanceType

      ClusterRestrictedInstanceGroupDetails.Builder instanceType(String instanceType)

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

      Parameters:
      instanceType - The instance type of the restricted 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

      ClusterRestrictedInstanceGroupDetails.Builder instanceType(ClusterInstanceType instanceType)

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

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

    • executionRole

      ClusterRestrictedInstanceGroupDetails.Builder executionRole(String executionRole)

      The execution role for the restricted instance group to assume.

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

    • threadsPerCore

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

      ClusterRestrictedInstanceGroupDetails.Builder instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)

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

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

    • instanceStorageConfigs

      ClusterRestrictedInstanceGroupDetails.Builder instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)

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

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

    • instanceStorageConfigs

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

      The additional storage configurations for the instances in the SageMaker HyperPod cluster restricted 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

      ClusterRestrictedInstanceGroupDetails.Builder onStartDeepHealthChecksWithStrings(Collection<String> onStartDeepHealthChecks)

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

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

    • onStartDeepHealthChecksWithStrings

      ClusterRestrictedInstanceGroupDetails.Builder onStartDeepHealthChecksWithStrings(String... onStartDeepHealthChecks)

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

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

    • onStartDeepHealthChecks

      ClusterRestrictedInstanceGroupDetails.Builder onStartDeepHealthChecks(Collection<DeepHealthCheckType> onStartDeepHealthChecks)

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

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

    • onStartDeepHealthChecks

      ClusterRestrictedInstanceGroupDetails.Builder onStartDeepHealthChecks(DeepHealthCheckType... onStartDeepHealthChecks)

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

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

    • status

      ClusterRestrictedInstanceGroupDetails.Builder status(String status)

      The current status of the cluster's restricted instance group.

      • InService: The restricted instance group is active and healthy.

      • Creating: The restricted instance group is being provisioned.

      • Updating: The restricted instance group is being updated.

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

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

      • Deleting: The restricted instance group is being deleted.

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

      • InService: The restricted instance group is active and healthy.

      • Creating: The restricted instance group is being provisioned.

      • Updating: The restricted instance group is being updated.

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

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

      • Deleting: The restricted instance group is being deleted.

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

    • status

      ClusterRestrictedInstanceGroupDetails.Builder status(InstanceGroupStatus status)

      The current status of the cluster's restricted instance group.

      • InService: The restricted instance group is active and healthy.

      • Creating: The restricted instance group is being provisioned.

      • Updating: The restricted instance group is being updated.

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

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

      • Deleting: The restricted instance group is being deleted.

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

      • InService: The restricted instance group is active and healthy.

      • Creating: The restricted instance group is being provisioned.

      • Updating: The restricted instance group is being updated.

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

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

      • Deleting: The restricted instance group is being deleted.

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

    • trainingPlanArn

      ClusterRestrictedInstanceGroupDetails.Builder trainingPlanArn(String trainingPlanArn)

      The Amazon Resource Name (ARN) of the training plan to filter clusters by. For more information about reserving 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 to filter clusters by. For more information about reserving 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

      ClusterRestrictedInstanceGroupDetails.Builder trainingPlanStatus(String trainingPlanStatus)

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

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

    • overrideVpcConfig

      ClusterRestrictedInstanceGroupDetails.Builder overrideVpcConfig(VpcConfig overrideVpcConfig)
      Sets the value of the OverrideVpcConfig property for this object.
      Parameters:
      overrideVpcConfig - The new value for the OverrideVpcConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideVpcConfig

      default ClusterRestrictedInstanceGroupDetails.Builder overrideVpcConfig(Consumer<VpcConfig.Builder> overrideVpcConfig)
      Sets the value of the OverrideVpcConfig property for this object. 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

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

    • scheduledUpdateConfig

      default ClusterRestrictedInstanceGroupDetails.Builder scheduledUpdateConfig(Consumer<ScheduledUpdateConfig.Builder> scheduledUpdateConfig)
      Sets the value of the ScheduledUpdateConfig property for this object. 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:

    • environmentConfig

      ClusterRestrictedInstanceGroupDetails.Builder environmentConfig(EnvironmentConfigDetails environmentConfig)

      The configuration for the restricted instance groups (RIG) environment.

      Parameters:
      environmentConfig - The configuration for the restricted instance groups (RIG) environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentConfig

      default ClusterRestrictedInstanceGroupDetails.Builder environmentConfig(Consumer<EnvironmentConfigDetails.Builder> environmentConfig)

      The configuration for the restricted instance groups (RIG) environment.

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

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

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