ProcessingClusterConfig (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class ProcessingClusterConfig

java.lang.Object
- com.amazonaws.services.sagemaker.model.ProcessingClusterConfig

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ProcessingClusterConfig
extends Object
implements Serializable, Cloneable, StructuredPojo

Configuration for the cluster used to run a processing job.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ProcessingClusterConfig ()

Constructors
Constructor and Description
`ProcessingClusterConfig ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`ProcessingClusterConfig`	`clone ()`
`boolean`	`equals (Object obj)`
`Integer`	`getInstanceCount ()` The number of ML compute instances to use in the processing job.
`String`	`getInstanceType ()` The ML compute instance type for the processing job.
`String`	`getVolumeKmsKeyId ()` 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`	`getVolumeSizeInGB ()` The size of the ML storage volume in gigabytes that you want to provision.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInstanceCount (Integer instanceCount)` The number of ML compute instances to use in the processing job.
`void`	`setInstanceType (String instanceType)` The ML compute instance type for the processing job.
`void`	`setVolumeKmsKeyId (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.
`void`	`setVolumeSizeInGB (Integer volumeSizeInGB)` The size of the ML storage volume in gigabytes that you want to provision.
`String`	`toString ()` Returns a string representation of this object.
`ProcessingClusterConfig`	`withInstanceCount (Integer instanceCount)` The number of ML compute instances to use in the processing job.
`ProcessingClusterConfig`	`withInstanceType (ProcessingInstanceType instanceType)` The ML compute instance type for the processing job.
`ProcessingClusterConfig`	`withInstanceType (String instanceType)` The ML compute instance type for the processing job.
`ProcessingClusterConfig`	`withVolumeKmsKeyId (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.
`ProcessingClusterConfig`	`withVolumeSizeInGB (Integer volumeSizeInGB)` The size of the ML storage volume in gigabytes that you want to provision.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ProcessingClusterConfig
```
public ProcessingClusterConfig()
```
- Method Detail
  - setInstanceCount
```
public void setInstanceCount(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.
    
    Parameters:
    
    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.
  - getInstanceCount
```
public Integer 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.
    
    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.
  - withInstanceCount
```
public ProcessingClusterConfig withInstanceCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The ML compute instance type for the processing job.
    
    Parameters:
    
    instanceType - The ML compute instance type for the processing job.
    
    See Also:
    
    ProcessingInstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The ML compute instance type for the processing job.
    
    Returns:
    
    The ML compute instance type for the processing job.
    
    See Also:
    
    ProcessingInstanceType
  - withInstanceType
```
public ProcessingClusterConfig withInstanceType(String instanceType)
```
    The ML compute instance type for the processing job.
    
    Parameters:
    
    instanceType - The ML compute instance type for the processing job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingInstanceType
  - withInstanceType
```
public ProcessingClusterConfig withInstanceType(ProcessingInstanceType instanceType)
```
    The ML compute instance type for the processing job.
    
    Parameters:
    
    instanceType - The ML compute instance type for the processing job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ProcessingInstanceType
  - setVolumeSizeInGB
```
public void setVolumeSizeInGB(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.
    
    Parameters:
    
    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.
  - getVolumeSizeInGB
```
public Integer 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.
    
    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.
  - withVolumeSizeInGB
```
public ProcessingClusterConfig withVolumeSizeInGB(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeKmsKeyId
```
public void setVolumeKmsKeyId(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.
    
    Parameters:
    
    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.
  - getVolumeKmsKeyId
```
public String getVolumeKmsKeyId()
```
    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.
  - withVolumeKmsKeyId
```
public ProcessingClusterConfig withVolumeKmsKeyId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ProcessingClusterConfig clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class ProcessingClusterConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcessingClusterConfig

Method Detail

setInstanceCount

getInstanceCount

withInstanceCount

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setVolumeSizeInGB

getVolumeSizeInGB

withVolumeSizeInGB

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

toString

equals

hashCode

clone

marshall