interface ClusterConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Sagemaker.CfnProcessingJob.ClusterConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssagemaker#CfnProcessingJob_ClusterConfigProperty`
Java	`software.amazon.awscdk.services.sagemaker.CfnProcessingJob.ClusterConfigProperty`
Python	`aws_cdk.aws_sagemaker.CfnProcessingJob.ClusterConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_sagemaker` » `CfnProcessingJob` » `ClusterConfigProperty`

Configuration for the cluster used to run a processing job.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sagemaker as sagemaker } from 'aws-cdk-lib';
const clusterConfigProperty: sagemaker.CfnProcessingJob.ClusterConfigProperty = {
  instanceCount: 123,
  instanceType: 'instanceType',
  volumeSizeInGb: 123,

  // the properties below are optional
  volumeKmsKeyId: 'volumeKmsKeyId',
};

Properties

Name	Type	Description
instanceCount	`number`	The number of ML compute instances to use in the processing job.
instanceType	`string`	The ML compute instance type for the processing job.
volumeSizeInGb	`number`	The size of the ML storage volume in gigabytes that you want to provision.
volumeKmsKeyId?	`string`	The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

instanceCount

Type: number

The number of ML compute instances to use in the processing job.

For distributed processing jobs, specify a value greater than 1. The default value is 1.

instanceType

Type: string

The ML compute instance type for the processing job.

volumeSizeInGb

Type: number

The size of the ML storage volume in gigabytes that you want to provision.

You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, Amazon SageMaker mounts the local instance storage instead of Amazon EBS gp2 storage. You can't request a VolumeSizeInGB greater than the total size of the local instance storage.

For a list of instance types that support local instance storage, including the total size per instance type, see Instance Store Volumes .

volumeKmsKeyId?

Type: string (optional)

The AWS Key Management Service ( AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.

Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId when using an instance type with local storage.

For a list of instance types that support local instance storage, see Instance Store Volumes .

For more information about local instance storage encryption, see SSD Instance Store Volumes .