Interface ClusterInstanceGroupSpecification.Builder

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

  • Method Details

    • instanceCount

      ClusterInstanceGroupSpecification.Builder instanceCount(Integer instanceCount)

      Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

      Parameters:
      instanceCount - Specifies the number of instances 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

      ClusterInstanceGroupSpecification.Builder instanceGroupName(String instanceGroupName)

      Specifies the name of the instance group.

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

    • instanceType

      ClusterInstanceGroupSpecification.Builder instanceType(String instanceType)

      Specifies the instance type of the instance group.

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

    • instanceType

      ClusterInstanceGroupSpecification.Builder instanceType(ClusterInstanceType instanceType)

      Specifies the instance type of the instance group.

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

    • lifeCycleConfig

      ClusterInstanceGroupSpecification.Builder lifeCycleConfig(ClusterLifeCycleConfig lifeCycleConfig)

      Specifies the LifeCycle configuration for the instance group.

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

    • lifeCycleConfig

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

      Specifies the 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

      ClusterInstanceGroupSpecification.Builder executionRole(String executionRole)

      Specifies an IAM execution role to be assumed by the instance group.

      Parameters:
      executionRole - Specifies an IAM execution role to be assumed by the instance group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • threadsPerCore

      ClusterInstanceGroupSpecification.Builder threadsPerCore(Integer threadsPerCore)

      Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. 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 - Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. 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

      ClusterInstanceGroupSpecification.Builder instanceStorageConfigs(Collection<ClusterInstanceStorageConfig> instanceStorageConfigs)

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

      Parameters:
      instanceStorageConfigs - Specifies 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

      ClusterInstanceGroupSpecification.Builder instanceStorageConfigs(ClusterInstanceStorageConfig... instanceStorageConfigs)

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

      Parameters:
      instanceStorageConfigs - Specifies 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

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

      Specifies 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

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

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

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

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

    • trainingPlanArn

      ClusterInstanceGroupSpecification.Builder trainingPlanArn(String trainingPlanArn)

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

    • overrideVpcConfig

      ClusterInstanceGroupSpecification.Builder overrideVpcConfig(VpcConfig overrideVpcConfig)

      To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

      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:

      Parameters:
      overrideVpcConfig - To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideVpcConfig

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

      To configure multi-AZ deployments, customize the Amazon VPC configuration at the instance group level. You can specify different subnets and security groups across different AZs in the instance group specification to override a SageMaker HyperPod cluster's default Amazon VPC configuration. For more information about deploying a cluster in multiple AZs, see Setting up SageMaker HyperPod clusters across multiple AZs.

      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:

      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

      ClusterInstanceGroupSpecification.Builder scheduledUpdateConfig(ScheduledUpdateConfig scheduledUpdateConfig)

      The configuration object of the schedule that SageMaker uses to update the AMI.

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

    • scheduledUpdateConfig

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

      The configuration object of the schedule that SageMaker uses to update 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: