Skip to content
v2.277.0

ClusterConfigProperty Struct ​

The configuration for the cluster resources used to run the processing job.

Example ​

ts
// 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.CfnModelExplainabilityJobDefinition.ClusterConfigProperty = {
  instanceCount: 123,
  instanceType: 'instanceType',
  volumeSizeInGb: 123,

  // the properties below are optional
  volumeKmsKeyId: 'volumeKmsKeyId',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sagemaker as sagemaker

cluster_config_property = sagemaker.CfnModelExplainabilityJobDefinition.ClusterConfigProperty(
    instance_count=123,
    instance_type="instanceType",
    volume_size_in_gb=123,

    # the properties below are optional
    volume_kms_key_id="volumeKmsKeyId"
)
java
// 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.*;

ClusterConfigProperty clusterConfigProperty = ClusterConfigProperty.builder()
        .instanceCount(123)
        .instanceType("instanceType")
        .volumeSizeInGb(123)

        // the properties below are optional
        .volumeKmsKeyId("volumeKmsKeyId")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Sagemaker;

var clusterConfigProperty = new ClusterConfigProperty {
    InstanceCount = 123,
    InstanceType = "instanceType",
    VolumeSizeInGb = 123,

    // the properties below are optional
    VolumeKmsKeyId = "volumeKmsKeyId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

clusterConfigProperty := &ClusterConfigProperty{
	InstanceCount: jsii.Number(123),
	InstanceType: jsii.String("instanceType"),
	VolumeSizeInGb: jsii.Number(123),

	// the properties below are optional
	VolumeKmsKeyId: jsii.String("volumeKmsKeyId"),
}

Properties ​

instanceCountnumberinstance_countint | floatinstanceCountNumberInstanceCountdoubleInstanceCount*float64 required #
The number of ML compute instances to use in the model monitoring job.

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

instanceTypestringinstance_typestrinstanceTypeStringInstanceTypestringInstanceType*string required #
The ML compute instance type for the processing job.
volumeKmsKeyIdoptionalstringvolume_kms_key_idoptionalstrvolumeKmsKeyIdoptionalStringVolumeKmsKeyIdoptionalstringVolumeKmsKeyIdoptional*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 model monitoring job.
volumeSizeInGbnumbervolume_size_in_gbint | floatvolumeSizeInGbNumberVolumeSizeInGbdoubleVolumeSizeInGb*float64 required #
The size of the ML storage volume, in gigabytes, that you want to provision.

You must specify sufficient ML storage for your scenario.