Package software.amazon.awscdk.services.sagemaker

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)
         .instanceStorageConfigs(List.of(ClusterInstanceStorageConfigProperty.builder()
                 .ebsVolumeConfig(ClusterEbsVolumeConfigProperty.builder()
                         .volumeSizeInGb(123)
                         .build())
                 .build()))
         .onStartDeepHealthChecks(List.of("onStartDeepHealthChecks"))
         .threadsPerCore(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.ClusterInstanceGroupProperty.Builder	A builder for CfnCluster.ClusterInstanceGroupProperty
static final class	CfnCluster.ClusterInstanceGroupProperty.Jsii$Proxy	An implementation for CfnCluster.ClusterInstanceGroupProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.ClusterInstanceGroupProperty.Builder	builder()
default Number	getCurrentCount()	The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
String	getExecutionRole()	The execution role for the instance group to assume.
Number	getInstanceCount()	The number of instances in an instance group of the SageMaker HyperPod cluster.
String	getInstanceGroupName()	The name of the instance group of a SageMaker HyperPod cluster.
default Object	getInstanceStorageConfigs()	The configurations of additional storage specified to the instance group where the instance (node) is launched.
String	getInstanceType()	The instance type of the instance group of a SageMaker HyperPod cluster.
Object	getLifeCycleConfig()	The lifecycle configuration for a SageMaker HyperPod cluster.
default List<String>	getOnStartDeepHealthChecks()	A flag indicating whether deep health checks should be performed when the HyperPod cluster instance group is created or updated.
default Number	getThreadsPerCore()	The number of threads per CPU core you specified under CreateCluster .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRole

@Stability(Stable)
@NotNull
String getExecutionRole()

The execution role for the instance group to assume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-executionrole

getInstanceCount

@Stability(Stable)
@NotNull
Number getInstanceCount()

The number of instances in an instance group of the SageMaker HyperPod cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancecount

getInstanceGroupName

@Stability(Stable)
@NotNull
String getInstanceGroupName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancegroupname

getInstanceType

@Stability(Stable)
@NotNull
String getInstanceType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancetype

getLifeCycleConfig

@Stability(Stable)
@NotNull
Object getLifeCycleConfig()

The lifecycle configuration for a SageMaker HyperPod cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-lifecycleconfig

getCurrentCount

@Stability(Stable)
@Nullable
default Number getCurrentCount()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-currentcount

getInstanceStorageConfigs

@Stability(Stable)
@Nullable
default Object getInstanceStorageConfigs()

The configurations of additional storage specified to the instance group where the instance (node) is launched.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-instancestorageconfigs

getOnStartDeepHealthChecks

@Stability(Stable)
@Nullable
default List<String> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-onstartdeephealthchecks

getThreadsPerCore

@Stability(Stable)
@Nullable
default Number getThreadsPerCore()

The number of threads per CPU core you specified under CreateCluster .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-cluster-clusterinstancegroup.html#cfn-sagemaker-cluster-clusterinstancegroup-threadspercore

builder

@Stability(Stable)
static CfnCluster.ClusterInstanceGroupProperty.Builder builder()

Returns:

a CfnCluster.ClusterInstanceGroupProperty.Builder of CfnCluster.ClusterInstanceGroupProperty