Interface CfnClusterProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-08-12T14:44:23.410Z") @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()
         .clusterName("clusterName")
         .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)
                 .instanceStorageConfigs(List.of(ClusterInstanceStorageConfigProperty.builder()
                         .ebsVolumeConfig(ClusterEbsVolumeConfigProperty.builder()
                                 .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()))
         .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()
                                 .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()))
         .vpcConfig(VpcConfigProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnets(List.of("subnets"))
                 .build())
         .build();
 

See Also: