Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Class CfnClusterPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.sagemaker.CfnClusterPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:04.862Z")
@Stability(Stable)
public class CfnClusterPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates an Amazon SageMaker HyperPod cluster.

SageMaker HyperPod is a capability of SageMaker for creating and managing persistent clusters for developing large machine learning models, such as large language models (LLMs) and diffusion models. To learn more, see Amazon SageMaker HyperPod in the Amazon SageMaker Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 Object onDemand;
 Object spot;
 CfnClusterPropsMixin cfnClusterPropsMixin = CfnClusterPropsMixin.Builder.create(CfnClusterMixinProps.builder()
         .autoScaling(ClusterAutoScalingConfigProperty.builder()
                 .autoScalerType("autoScalerType")
                 .mode("mode")
                 .build())
         .clusterName("clusterName")
         .clusterRole("clusterRole")
         .instanceGroups(List.of(ClusterInstanceGroupProperty.builder()
                 .capacityRequirements(ClusterCapacityRequirementsProperty.builder()
                         .onDemand(onDemand)
                         .spot(spot)
                         .build())
                 .currentCount(123)
                 .executionRole("executionRole")
                 .imageId("imageId")
                 .instanceCount(123)
                 .instanceGroupName("instanceGroupName")
                 .instanceStorageConfigs(List.of(ClusterInstanceStorageConfigProperty.builder()
                         .ebsVolumeConfig(ClusterEbsVolumeConfigProperty.builder()
                                 .rootVolume(false)
                                 .volumeKmsKeyId("volumeKmsKeyId")
                                 .volumeSizeInGb(123)
                                 .build())
                         .fsxLustreConfig(ClusterFsxLustreConfigProperty.builder()
                                 .dnsName("dnsName")
                                 .mountName("mountName")
                                 .mountPath("mountPath")
                                 .build())
                         .fsxOpenZfsConfig(ClusterFsxOpenZfsConfigProperty.builder()
                                 .dnsName("dnsName")
                                 .mountPath("mountPath")
                                 .build())
                         .build()))
                 .instanceType("instanceType")
                 .kubernetesConfig(ClusterKubernetesConfigProperty.builder()
                         .labels(Map.of(
                                 "labelsKey", "labels"))
                         .taints(List.of(ClusterKubernetesTaintProperty.builder()
                                 .effect("effect")
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build())
                 .lifeCycleConfig(ClusterLifeCycleConfigProperty.builder()
                         .onCreate("onCreate")
                         .sourceS3Uri("sourceS3Uri")
                         .build())
                 .minInstanceCount(123)
                 .onStartDeepHealthChecks(List.of("onStartDeepHealthChecks"))
                 .overrideVpcConfig(VpcConfigProperty.builder()
                         .securityGroupIds(List.of("securityGroupIds"))
                         .subnets(List.of("subnets"))
                         .build())
                 .scheduledUpdateConfig(ScheduledUpdateConfigProperty.builder()
                         .deploymentConfig(DeploymentConfigProperty.builder()
                                 .autoRollbackConfiguration(List.of(AlarmDetailsProperty.builder()
                                         .alarmName("alarmName")
                                         .build()))
                                 .rollingUpdatePolicy(RollingUpdatePolicyProperty.builder()
                                         .maximumBatchSize(CapacitySizeConfigProperty.builder()
                                                 .type("type")
                                                 .value(123)
                                                 .build())
                                         .rollbackMaximumBatchSize(CapacitySizeConfigProperty.builder()
                                                 .type("type")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .waitIntervalInSeconds(123)
                                 .build())
                         .scheduleExpression("scheduleExpression")
                         .build())
                 .slurmConfig(ClusterSlurmConfigProperty.builder()
                         .nodeType("nodeType")
                         .partitionNames(List.of("partitionNames"))
                         .build())
                 .threadsPerCore(123)
                 .trainingPlanArn("trainingPlanArn")
                 .build()))
         .nodeProvisioningMode("nodeProvisioningMode")
         .nodeRecovery("nodeRecovery")
         .orchestrator(OrchestratorProperty.builder()
                 .eks(ClusterOrchestratorEksConfigProperty.builder()
                         .clusterArn("clusterArn")
                         .build())
                 .slurm(ClusterOrchestratorSlurmConfigProperty.builder()
                         .slurmConfigStrategy("slurmConfigStrategy")
                         .build())
                 .build())
         .restrictedInstanceGroups(List.of(ClusterRestrictedInstanceGroupProperty.builder()
                 .currentCount(123)
                 .environmentConfig(EnvironmentConfigProperty.builder()
                         .fSxLustreConfig(FSxLustreConfigProperty.builder()
                                 .perUnitStorageThroughput(123)
                                 .sizeInGiB(123)
                                 .build())
                         .build())
                 .executionRole("executionRole")
                 .instanceCount(123)
                 .instanceGroupName("instanceGroupName")
                 .instanceStorageConfigs(List.of(ClusterInstanceStorageConfigProperty.builder()
                         .ebsVolumeConfig(ClusterEbsVolumeConfigProperty.builder()
                                 .rootVolume(false)
                                 .volumeKmsKeyId("volumeKmsKeyId")
                                 .volumeSizeInGb(123)
                                 .build())
                         .fsxLustreConfig(ClusterFsxLustreConfigProperty.builder()
                                 .dnsName("dnsName")
                                 .mountName("mountName")
                                 .mountPath("mountPath")
                                 .build())
                         .fsxOpenZfsConfig(ClusterFsxOpenZfsConfigProperty.builder()
                                 .dnsName("dnsName")
                                 .mountPath("mountPath")
                                 .build())
                         .build()))
                 .instanceType("instanceType")
                 .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()
                 .instanceMemoryAllocationPercentage(123)
                 .mode("mode")
                 .build())
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnClusterPropsMixin.AlarmDetailsProperty	The details of the alarm to monitor during the AMI update.
static final class	CfnClusterPropsMixin.Builder	A fluent builder for CfnClusterPropsMixin.
static interface	CfnClusterPropsMixin.CapacitySizeConfigProperty	The configuration of the size measurements of the AMI update.
static interface	CfnClusterPropsMixin.ClusterAutoScalingConfigProperty	Specifies the autoscaling configuration for a HyperPod cluster.
static interface	CfnClusterPropsMixin.ClusterCapacityRequirementsProperty	Defines the instance capacity requirements for an instance group, including configurations for both Spot and On-Demand capacity types.
static interface	CfnClusterPropsMixin.ClusterEbsVolumeConfigProperty	Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group.
static interface	CfnClusterPropsMixin.ClusterFsxLustreConfigProperty	Configuration for mounting an Amazon FSx Lustre file system to the instances in the SageMaker HyperPod cluster instance group.
static interface	CfnClusterPropsMixin.ClusterFsxOpenZfsConfigProperty	Configuration for mounting an Amazon FSx OpenZFS file system to the instances in the SageMaker HyperPod cluster instance group.
static interface	CfnClusterPropsMixin.ClusterInstanceGroupProperty	The configuration information of the instance group within the HyperPod cluster.
static interface	CfnClusterPropsMixin.ClusterInstanceStorageConfigProperty	Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group.
static interface	CfnClusterPropsMixin.ClusterKubernetesConfigProperty	Kubernetes configuration that specifies labels and taints to be applied to cluster nodes in an instance group.
static interface	CfnClusterPropsMixin.ClusterKubernetesTaintProperty	A Kubernetes taint that can be applied to cluster nodes.
static interface	CfnClusterPropsMixin.ClusterLifeCycleConfigProperty	The lifecycle configuration for a SageMaker HyperPod cluster.
static interface	CfnClusterPropsMixin.ClusterOrchestratorEksConfigProperty	The configuration for the Amazon EKS cluster that is used as the orchestrator for the SageMaker HyperPod cluster.
static interface	CfnClusterPropsMixin.ClusterOrchestratorSlurmConfigProperty	Specifies parameter(s) related to Slurm as orchestrator.
static interface	CfnClusterPropsMixin.ClusterRestrictedInstanceGroupProperty	Details of a restricted instance group in a SageMaker HyperPod cluster.
static interface	CfnClusterPropsMixin.ClusterSlurmConfigProperty	Slurm configuration for the instance group.
static interface	CfnClusterPropsMixin.DeploymentConfigProperty	The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.
static interface	CfnClusterPropsMixin.EnvironmentConfigProperty	The configuration for the restricted instance groups (RIG) environment.
static interface	CfnClusterPropsMixin.FSxLustreConfigProperty	Configuration settings for an Amazon FSx for Lustre file system to be used with the cluster.
static interface	CfnClusterPropsMixin.OrchestratorProperty	The orchestrator for a SageMaker HyperPod cluster.
static interface	CfnClusterPropsMixin.RollingUpdatePolicyProperty	Specifies a rolling deployment strategy for updating a SageMaker endpoint.
static interface	CfnClusterPropsMixin.ScheduledUpdateConfigProperty	The configuration object of the schedule that SageMaker follows when updating the AMI.
static interface	CfnClusterPropsMixin.TieredStorageConfigProperty	Configuration for tiered storage in the SageMaker HyperPod cluster.
static interface	CfnClusterPropsMixin.VpcConfigProperty	Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnClusterPropsMixin(CfnClusterMixinProps props)	Create a mixin to apply properties to AWS::SageMaker::Cluster.
	CfnClusterPropsMixin(CfnClusterMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::SageMaker::Cluster.
protected	CfnClusterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnClusterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnClusterMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnClusterPropsMixin

protected CfnClusterPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnClusterPropsMixin

protected CfnClusterPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnClusterPropsMixin

@Stability(Stable)
public CfnClusterPropsMixin(@NotNull
 CfnClusterMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::SageMaker::Cluster.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnClusterPropsMixin

@Stability(Stable)
public CfnClusterPropsMixin(@NotNull
 CfnClusterMixinProps props)

Create a mixin to apply properties to AWS::SageMaker::Cluster.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnClusterMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()