Class CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnClusterPropsMixin.ClusterInstanceGroupProperty>
- Enclosing interface:
CfnClusterPropsMixin.ClusterInstanceGroupProperty
@Stability(Stable)
public static final class CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnClusterPropsMixin.ClusterInstanceGroupProperty>
A builder for
CfnClusterPropsMixin.ClusterInstanceGroupProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.capacityRequirements(CfnClusterPropsMixin.ClusterCapacityRequirementsProperty capacityRequirements) capacityRequirements(IResolvable capacityRequirements) currentCount(Number currentCount) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getCurrentCount()executionRole(String executionRole) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getExecutionRole()Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getImageId()instanceCount(Number instanceCount) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getInstanceCount()instanceGroupName(String instanceGroupName) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getInstanceGroupName()instanceStorageConfigs(List<? extends Object> instanceStorageConfigs) instanceStorageConfigs(IResolvable instanceStorageConfigs) instanceType(String instanceType) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getInstanceType()kubernetesConfig(CfnClusterPropsMixin.ClusterKubernetesConfigProperty kubernetesConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getKubernetesConfig()kubernetesConfig(IResolvable kubernetesConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getKubernetesConfig()lifeCycleConfig(CfnClusterPropsMixin.ClusterLifeCycleConfigProperty lifeCycleConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getLifeCycleConfig()lifeCycleConfig(IResolvable lifeCycleConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getLifeCycleConfig()minInstanceCount(Number minInstanceCount) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getMinInstanceCount()onStartDeepHealthChecks(List<String> onStartDeepHealthChecks) overrideVpcConfig(CfnClusterPropsMixin.VpcConfigProperty overrideVpcConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getOverrideVpcConfig()overrideVpcConfig(IResolvable overrideVpcConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getOverrideVpcConfig()scheduledUpdateConfig(CfnClusterPropsMixin.ScheduledUpdateConfigProperty scheduledUpdateConfig) scheduledUpdateConfig(IResolvable scheduledUpdateConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getSlurmConfig()slurmConfig(IResolvable slurmConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getSlurmConfig()threadsPerCore(Number threadsPerCore) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getThreadsPerCore()trainingPlanArn(String trainingPlanArn) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getTrainingPlanArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
capacityRequirements
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder capacityRequirements(IResolvable capacityRequirements) - Parameters:
capacityRequirements- Specifies the capacity requirements configuration for an instance group.- Returns:
this
-
capacityRequirements
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder capacityRequirements(CfnClusterPropsMixin.ClusterCapacityRequirementsProperty capacityRequirements) - Parameters:
capacityRequirements- Specifies the capacity requirements configuration for an instance group.- Returns:
this
-
currentCount
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder currentCount(Number currentCount) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getCurrentCount()- Parameters:
currentCount- The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.- Returns:
this
-
executionRole
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder executionRole(String executionRole) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getExecutionRole()- Parameters:
executionRole- The execution role for the instance group to assume.- Returns:
this
-
imageId
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder imageId(String imageId) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getImageId()- Parameters:
imageId- AMI Id to be used for launching EC2 instances - HyperPodPublicAmiId or CustomAmiId.- Returns:
this
-
instanceCount
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder instanceCount(Number instanceCount) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getInstanceCount()- Parameters:
instanceCount- The number of instances in an instance group of the SageMaker HyperPod cluster.- Returns:
this
-
instanceGroupName
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder instanceGroupName(String instanceGroupName) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getInstanceGroupName()- Parameters:
instanceGroupName- The name of the instance group of a SageMaker HyperPod cluster.- Returns:
this
-
instanceStorageConfigs
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder instanceStorageConfigs(IResolvable instanceStorageConfigs) - Parameters:
instanceStorageConfigs- The configurations of additional storage specified to the instance group where the instance (node) is launched.- Returns:
this
-
instanceStorageConfigs
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder instanceStorageConfigs(List<? extends Object> instanceStorageConfigs) - Parameters:
instanceStorageConfigs- The configurations of additional storage specified to the instance group where the instance (node) is launched.- Returns:
this
-
instanceType
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder instanceType(String instanceType) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getInstanceType()- Parameters:
instanceType- The instance type of the instance group of a SageMaker HyperPod cluster.- Returns:
this
-
kubernetesConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder kubernetesConfig(IResolvable kubernetesConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getKubernetesConfig()- Parameters:
kubernetesConfig- Kubernetes configuration for cluster nodes including labels and taints.- Returns:
this
-
kubernetesConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder kubernetesConfig(CfnClusterPropsMixin.ClusterKubernetesConfigProperty kubernetesConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getKubernetesConfig()- Parameters:
kubernetesConfig- Kubernetes configuration for cluster nodes including labels and taints.- Returns:
this
-
lifeCycleConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder lifeCycleConfig(IResolvable lifeCycleConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getLifeCycleConfig()- Parameters:
lifeCycleConfig- The lifecycle configuration for a SageMaker HyperPod cluster.- Returns:
this
-
lifeCycleConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder lifeCycleConfig(CfnClusterPropsMixin.ClusterLifeCycleConfigProperty lifeCycleConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getLifeCycleConfig()- Parameters:
lifeCycleConfig- The lifecycle configuration for a SageMaker HyperPod cluster.- Returns:
this
-
minInstanceCount
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder minInstanceCount(Number minInstanceCount) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getMinInstanceCount()- Parameters:
minInstanceCount- The minimum number of instances required for the instance group to be InService. MinInstanceCount must be less than or equal to InstanceCount.- Returns:
this
-
onStartDeepHealthChecks
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder onStartDeepHealthChecks(List<String> onStartDeepHealthChecks) - Parameters:
onStartDeepHealthChecks- A flag indicating whether deep health checks should be performed when the HyperPod cluster instance group is created or updated. Deep health checks are comprehensive, invasive tests that validate the health of the underlying hardware and infrastructure components.- Returns:
this
-
overrideVpcConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder overrideVpcConfig(IResolvable overrideVpcConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getOverrideVpcConfig()- 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:
this
-
overrideVpcConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder overrideVpcConfig(CfnClusterPropsMixin.VpcConfigProperty overrideVpcConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getOverrideVpcConfig()- 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:
this
-
scheduledUpdateConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder scheduledUpdateConfig(IResolvable scheduledUpdateConfig) - Parameters:
scheduledUpdateConfig- The configuration object of the schedule that SageMaker follows when updating the AMI.- Returns:
this
-
scheduledUpdateConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder scheduledUpdateConfig(CfnClusterPropsMixin.ScheduledUpdateConfigProperty scheduledUpdateConfig) - Parameters:
scheduledUpdateConfig- The configuration object of the schedule that SageMaker follows when updating the AMI.- Returns:
this
-
slurmConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder slurmConfig(IResolvable slurmConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getSlurmConfig()- Parameters:
slurmConfig- Slurm configuration for the instance group.- Returns:
this
-
slurmConfig
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder slurmConfig(CfnClusterPropsMixin.ClusterSlurmConfigProperty slurmConfig) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getSlurmConfig()- Parameters:
slurmConfig- Slurm configuration for the instance group.- Returns:
this
-
threadsPerCore
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder threadsPerCore(Number threadsPerCore) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getThreadsPerCore()- Parameters:
threadsPerCore- The number of threads per CPU core you specified underCreateCluster.- Returns:
this
-
trainingPlanArn
@Stability(Stable) public CfnClusterPropsMixin.ClusterInstanceGroupProperty.Builder trainingPlanArn(String trainingPlanArn) Sets the value ofCfnClusterPropsMixin.ClusterInstanceGroupProperty.getTrainingPlanArn()- 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:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnClusterPropsMixin.ClusterInstanceGroupProperty>- Returns:
- a new instance of
CfnClusterPropsMixin.ClusterInstanceGroupProperty - Throws:
NullPointerException- if any required attribute was not provided
-