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.104.0 (build e79254c)", date="2024-11-21T06:34:15.566Z") @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()
         .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)
                 .build()))
         // the properties below are optional
         .clusterName("clusterName")
         .nodeRecovery("nodeRecovery")
         .orchestrator(OrchestratorProperty.builder()
                 .eks(ClusterOrchestratorEksConfigProperty.builder()
                         .clusterArn("clusterArn")
                         .build())
                 .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:

  • 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 String
    getClusterName()
    The name of the SageMaker HyperPod cluster.
    Object
    getInstanceGroups()
    The instance groups of 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 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
    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