Interface CfnCluster.ClusterInstanceGroupProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCluster.ClusterInstanceGroupProperty.Jsii$Proxy
- Enclosing class:
CfnCluster
@Stability(Stable)
public static interface CfnCluster.ClusterInstanceGroupProperty
extends software.amazon.jsii.JsiiSerializable
The configuration information of the instance group within the HyperPod cluster.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sagemaker.*;
ClusterInstanceGroupProperty clusterInstanceGroupProperty = ClusterInstanceGroupProperty.builder()
.executionRole("executionRole")
.instanceCount(123)
.instanceGroupName("instanceGroupName")
.instanceType("instanceType")
.lifeCycleConfig(ClusterLifeCycleConfigProperty.builder()
.onCreate("onCreate")
.sourceS3Uri("sourceS3Uri")
.build())
// the properties below are optional
.currentCount(123)
.imageId("imageId")
.instanceStorageConfigs(List.of(ClusterInstanceStorageConfigProperty.builder()
.ebsVolumeConfig(ClusterEbsVolumeConfigProperty.builder()
.rootVolume(false)
.volumeKmsKeyId("volumeKmsKeyId")
.volumeSizeInGb(123)
.build())
.build()))
.onStartDeepHealthChecks(List.of("onStartDeepHealthChecks"))
.overrideVpcConfig(VpcConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnets(List.of("subnets"))
.build())
.scheduledUpdateConfig(ScheduledUpdateConfigProperty.builder()
.scheduleExpression("scheduleExpression")
// the properties below are optional
.deploymentConfig(DeploymentConfigProperty.builder()
.autoRollbackConfiguration(List.of(AlarmDetailsProperty.builder()
.alarmName("alarmName")
.build()))
.rollingUpdatePolicy(RollingUpdatePolicyProperty.builder()
.maximumBatchSize(CapacitySizeConfigProperty.builder()
.type("type")
.value(123)
.build())
// the properties below are optional
.rollbackMaximumBatchSize(CapacitySizeConfigProperty.builder()
.type("type")
.value(123)
.build())
.build())
.waitIntervalInSeconds(123)
.build())
.build())
.threadsPerCore(123)
.trainingPlanArn("trainingPlanArn")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnCluster.ClusterInstanceGroupPropertystatic final classAn implementation forCfnCluster.ClusterInstanceGroupProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default NumberThe number of instances that are currently in the instance group of a SageMaker HyperPod cluster.The execution role for the instance group to assume.default StringAMI Id to be used for launching EC2 instances - HyperPodPublicAmiId or CustomAmiId.The number of instances in an instance group of the SageMaker HyperPod cluster.The name of the instance group of a SageMaker HyperPod cluster.default ObjectThe configurations of additional storage specified to the instance group where the instance (node) is launched.The instance type of the instance group of a SageMaker HyperPod cluster.The lifecycle configuration for a SageMaker HyperPod cluster.A flag indicating whether deep health checks should be performed when the HyperPod cluster instance group is created or updated.default ObjectThe customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.default ObjectThe configuration object of the schedule that SageMaker follows when updating the AMI.default NumberThe number of threads per CPU core you specified underCreateCluster.default StringThe Amazon Resource Name (ARN) of the training plan to use for this cluster instance group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExecutionRole
The execution role for the instance group to assume.- See Also:
-
getInstanceCount
The number of instances in an instance group of the SageMaker HyperPod cluster.- See Also:
-
getInstanceGroupName
The name of the instance group of a SageMaker HyperPod cluster.- See Also:
-
getInstanceType
The instance type of the instance group of a SageMaker HyperPod cluster.- See Also:
-
getLifeCycleConfig
The lifecycle configuration for a SageMaker HyperPod cluster.Returns union: either
IResolvableorCfnCluster.ClusterLifeCycleConfigProperty- See Also:
-
getCurrentCount
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.- See Also:
-
getImageId
AMI Id to be used for launching EC2 instances - HyperPodPublicAmiId or CustomAmiId.- See Also:
-
getInstanceStorageConfigs
The configurations of additional storage specified to the instance group where the instance (node) is launched.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnCluster.ClusterInstanceStorageConfigProperty>- See Also:
-
getOnStartDeepHealthChecks
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.
- See Also:
-
getOverrideVpcConfig
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.Returns union: either
IResolvableorCfnCluster.VpcConfigProperty- See Also:
-
getScheduledUpdateConfig
The configuration object of the schedule that SageMaker follows when updating the AMI.Returns union: either
IResolvableorCfnCluster.ScheduledUpdateConfigProperty- See Also:
-
getThreadsPerCore
The number of threads per CPU core you specified underCreateCluster.- See Also:
-
getTrainingPlanArn
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.
- See Also:
-
builder
-