Package software.amazon.awscdk.services.sagemaker

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:29.511Z")
@Stability(Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCluster.

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.*;
 CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
         .autoScaling(ClusterAutoScalingConfigProperty.builder()
                 .mode("mode")
                 // the properties below are optional
                 .autoScalerType("autoScalerType")
                 .build())
         .clusterName("clusterName")
         .clusterRole("clusterRole")
         .instanceGroups(List.of(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()))
         .nodeProvisioningMode("nodeProvisioningMode")
         .nodeRecovery("nodeRecovery")
         .orchestrator(OrchestratorProperty.builder()
                 .eks(ClusterOrchestratorEksConfigProperty.builder()
                         .clusterArn("clusterArn")
                         .build())
                 .build())
         .restrictedInstanceGroups(List.of(ClusterRestrictedInstanceGroupProperty.builder()
                 .environmentConfig(EnvironmentConfigProperty.builder()
                         .fSxLustreConfig(FSxLustreConfigProperty.builder()
                                 .perUnitStorageThroughput(123)
                                 .sizeInGiB(123)
                                 .build())
                         .build())
                 .executionRole("executionRole")
                 .instanceCount(123)
                 .instanceGroupName("instanceGroupName")
                 .instanceType("instanceType")
                 // the properties below are optional
                 .currentCount(123)
                 .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())
                 .threadsPerCore(123)
                 .trainingPlanArn("trainingPlanArn")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tieredStorageConfig(TieredStorageConfigProperty.builder()
                 .mode("mode")
                 // the properties below are optional
                 .instanceMemoryAllocationPercentage(123)
                 .build())
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnClusterProps.Builder	builder()
default Object	getAutoScaling()	Configuration for cluster auto-scaling.
default String	getClusterName()	The name of the SageMaker HyperPod cluster.
default String	getClusterRole()	The cluster role for the autoscaler to assume.
default Object	getInstanceGroups()	The instance groups of the SageMaker HyperPod cluster.
default String	getNodeProvisioningMode()	Determines the scaling strategy for the SageMaker HyperPod cluster.
default String	getNodeRecovery()	Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod.
default Object	getOrchestrator()	The orchestrator type for the SageMaker HyperPod cluster.
default Object	getRestrictedInstanceGroups()	The restricted instance groups of the SageMaker HyperPod cluster.
default List<CfnTag>	getTags()	A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.
default Object	getTieredStorageConfig()	Configuration for tiered storage in the SageMaker HyperPod cluster.
default Object	getVpcConfig()	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAutoScaling

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

Configuration for cluster auto-scaling.

Returns union: either IResolvable or CfnCluster.ClusterAutoScalingConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-autoscaling

getClusterName

@Stability(Stable)
@Nullable
default String getClusterName()

The name of the SageMaker HyperPod cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clustername

getClusterRole

@Stability(Stable)
@Nullable
default String getClusterRole()

The cluster role for the autoscaler to assume.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-clusterrole

getInstanceGroups

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

The instance groups of the SageMaker HyperPod cluster.

To delete an instance group, remove it from the array.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCluster.ClusterInstanceGroupProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-instancegroups

getNodeProvisioningMode

@Stability(Stable)
@Nullable
default String getNodeProvisioningMode()

Determines the scaling strategy for the SageMaker HyperPod cluster.

When set to 'Continuous', enables continuous scaling which dynamically manages node provisioning. If the parameter is omitted, uses the standard scaling approach in previous release.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-nodeprovisioningmode

getNodeRecovery

@Stability(Stable)
@Nullable
default String getNodeRecovery()

Specifies whether to enable or disable the automatic node recovery feature of SageMaker HyperPod.

Available values are Automatic for enabling and None for disabling.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-noderecovery

getOrchestrator

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

The orchestrator type for the SageMaker HyperPod cluster.

Currently, 'eks' is the only available option.

Returns union: either IResolvable or CfnCluster.OrchestratorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-orchestrator

getRestrictedInstanceGroups

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

The restricted instance groups of the SageMaker HyperPod cluster.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCluster.ClusterRestrictedInstanceGroupProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-restrictedinstancegroups

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A tag object that consists of a key and an optional value, used to manage metadata for SageMaker AWS resources.

You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .

For more information on adding metadata to your AWS resources with tagging, see Tagging AWS resources . For advice on best practices for managing AWS resources with tagging, see Tagging Best Practices: Implement an Effective AWS Resource Tagging Strategy .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tags

getTieredStorageConfig

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

Configuration for tiered storage in the SageMaker HyperPod cluster.

Returns union: either IResolvable or CfnCluster.TieredStorageConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-tieredstorageconfig

getVpcConfig

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

Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC .

Returns union: either IResolvable or CfnCluster.VpcConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-cluster.html#cfn-sagemaker-cluster-vpcconfig

builder

@Stability(Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps