class CfnClusterPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SageMaker.Mixins.CfnClusterPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssagemaker/mixins#CfnClusterPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.sagemaker.mixins.CfnClusterPropsMixin
Python	aws_cdk.mixins_preview.aws_sagemaker.mixins.CfnClusterPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_sagemaker » mixins » CfnClusterPropsMixin

Implements IMixin

Extends Mixin

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 .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as sagemaker_mixins } from '@aws-cdk/mixins-preview/aws-sagemaker';

declare const onDemand: any;
declare const spot: any;
const cfnClusterPropsMixin = new sagemaker_mixins.CfnClusterPropsMixin({
  autoScaling: {
    autoScalerType: 'autoScalerType',
    mode: 'mode',
  },
  clusterName: 'clusterName',
  clusterRole: 'clusterRole',
  instanceGroups: [{
    capacityRequirements: {
      onDemand: onDemand,
      spot: spot,
    },
    currentCount: 123,
    executionRole: 'executionRole',
    imageId: 'imageId',
    instanceCount: 123,
    instanceGroupName: 'instanceGroupName',
    instanceStorageConfigs: [{
      ebsVolumeConfig: {
        rootVolume: false,
        volumeKmsKeyId: 'volumeKmsKeyId',
        volumeSizeInGb: 123,
      },
    }],
    instanceType: 'instanceType',
    kubernetesConfig: {
      labels: {
        labelsKey: 'labels',
      },
      taints: [{
        effect: 'effect',
        key: 'key',
        value: 'value',
      }],
    },
    lifeCycleConfig: {
      onCreate: 'onCreate',
      sourceS3Uri: 'sourceS3Uri',
    },
    minInstanceCount: 123,
    onStartDeepHealthChecks: ['onStartDeepHealthChecks'],
    overrideVpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
    scheduledUpdateConfig: {
      deploymentConfig: {
        autoRollbackConfiguration: [{
          alarmName: 'alarmName',
        }],
        rollingUpdatePolicy: {
          maximumBatchSize: {
            type: 'type',
            value: 123,
          },
          rollbackMaximumBatchSize: {
            type: 'type',
            value: 123,
          },
        },
        waitIntervalInSeconds: 123,
      },
      scheduleExpression: 'scheduleExpression',
    },
    threadsPerCore: 123,
    trainingPlanArn: 'trainingPlanArn',
  }],
  nodeProvisioningMode: 'nodeProvisioningMode',
  nodeRecovery: 'nodeRecovery',
  orchestrator: {
    eks: {
      clusterArn: 'clusterArn',
    },
  },
  restrictedInstanceGroups: [{
    currentCount: 123,
    environmentConfig: {
      fSxLustreConfig: {
        perUnitStorageThroughput: 123,
        sizeInGiB: 123,
      },
    },
    executionRole: 'executionRole',
    instanceCount: 123,
    instanceGroupName: 'instanceGroupName',
    instanceStorageConfigs: [{
      ebsVolumeConfig: {
        rootVolume: false,
        volumeKmsKeyId: 'volumeKmsKeyId',
        volumeSizeInGb: 123,
      },
    }],
    instanceType: 'instanceType',
    onStartDeepHealthChecks: ['onStartDeepHealthChecks'],
    overrideVpcConfig: {
      securityGroupIds: ['securityGroupIds'],
      subnets: ['subnets'],
    },
    threadsPerCore: 123,
    trainingPlanArn: 'trainingPlanArn',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tieredStorageConfig: {
    instanceMemoryAllocationPercentage: 123,
    mode: 'mode',
  },
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnets: ['subnets'],
  },
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnClusterPropsMixin(props: CfnClusterMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnClusterMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnClusterMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnClusterMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.