Package software.amazon.awssdk.services.sagemaker.model

Class ProcessingClusterConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ProcessingClusterConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ProcessingClusterConfig.Builder,ProcessingClusterConfig>

@Generated("software.amazon.awssdk:codegen")
public final class ProcessingClusterConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ProcessingClusterConfig.Builder,ProcessingClusterConfig>

Configuration for the cluster used to run a processing job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProcessingClusterConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ProcessingClusterConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceCount()	The number of ML compute instances to use in the processing job.
ProcessingInstanceType	instanceType()	The ML compute instance type for the processing job.
String	instanceTypeAsString()	The ML compute instance type for the processing job.
List<SdkField<?>>	sdkFields()
static Class<? extends ProcessingClusterConfig.Builder>	serializableBuilderClass()
ProcessingClusterConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	volumeKmsKeyId()	The Amazon Web Services Key Management Service (Amazon Web Services 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.
Integer	volumeSizeInGB()	The size of the ML storage volume in gigabytes that you want to provision.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

instanceCount

public final Integer instanceCount()

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.

Returns:

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

public final ProcessingInstanceType instanceType()

The ML compute instance type for the processing job.

If the service returns an enum value that is not available in the current SDK version, instanceType will return ProcessingInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The ML compute instance type for the processing job.

See Also:

ProcessingInstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The ML compute instance type for the processing job.

If the service returns an enum value that is not available in the current SDK version, instanceType will return ProcessingInstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

The ML compute instance type for the processing job.

See Also:

ProcessingInstanceType

volumeSizeInGB

public final Integer volumeSizeInGB()

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.

Returns:

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

public final String volumeKmsKeyId()

The Amazon Web Services Key Management Service (Amazon Web Services 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.

Returns:

The Amazon Web Services Key Management Service (Amazon Web Services 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.

toBuilder

public ProcessingClusterConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ProcessingClusterConfig.Builder,ProcessingClusterConfig>

builder

public static ProcessingClusterConfig.Builder builder()

serializableBuilderClass

public static Class<? extends ProcessingClusterConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo