Package software.amazon.awscdk.cfnpropertymixins.services.sagemaker

Interface CfnProcessingJobPropsMixin.ClusterConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnProcessingJobPropsMixin.ClusterConfigProperty.Jsii$Proxy

Enclosing class:

CfnProcessingJobPropsMixin

@Stability(Stable)
public static interface CfnProcessingJobPropsMixin.ClusterConfigProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.sagemaker.*;
 ClusterConfigProperty clusterConfigProperty = ClusterConfigProperty.builder()
         .instanceCount(123)
         .instanceType("instanceType")
         .volumeKmsKeyId("volumeKmsKeyId")
         .volumeSizeInGb(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnProcessingJobPropsMixin.ClusterConfigProperty.Builder	A builder for CfnProcessingJobPropsMixin.ClusterConfigProperty
static final class	CfnProcessingJobPropsMixin.ClusterConfigProperty.Jsii$Proxy	An implementation for CfnProcessingJobPropsMixin.ClusterConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnProcessingJobPropsMixin.ClusterConfigProperty.Builder	builder()
default Number	getInstanceCount()	The number of ML compute instances to use in the processing job.
default String	getInstanceType()	The ML compute instance type for the processing job.
default String	getVolumeKmsKeyId()	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.
default Number	getVolumeSizeInGb()	The size of the ML storage volume in gigabytes that you want to provision.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceCount

@Stability(Stable)
@Nullable
default Number getInstanceCount()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-instancecount

getInstanceType

@Stability(Stable)
@Nullable
default String getInstanceType()

The ML compute instance type for the processing job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-instancetype

getVolumeKmsKeyId

@Stability(Stable)
@Nullable
default String getVolumeKmsKeyId()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-volumekmskeyid

getVolumeSizeInGb

@Stability(Stable)
@Nullable
default Number getVolumeSizeInGb()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-processingjob-clusterconfig.html#cfn-sagemaker-processingjob-clusterconfig-volumesizeingb

builder

@Stability(Stable)
static CfnProcessingJobPropsMixin.ClusterConfigProperty.Builder builder()

Returns:

a CfnProcessingJobPropsMixin.ClusterConfigProperty.Builder of CfnProcessingJobPropsMixin.ClusterConfigProperty