ResourceConfig (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ResourceConfig
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the resources, including ML compute instances and ML storage volumes, to use for model training.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ResourceConfig()

Constructors
Constructor and Description
`ResourceConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ResourceConfig`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getInstanceCount()` The number of ML compute instances to use.
`String`	`getInstanceType()` The ML compute instance type.
`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 training job.
`Integer`	`getVolumeSizeInGB()` The size of the ML storage volume 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.
`void`	`setInstanceType(String instanceType)` The ML compute instance type.
`void`	`setVolumeKmsKeyId(String volumeKmsKeyId)` 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 training job.
`void`	`setVolumeSizeInGB(Integer volumeSizeInGB)` The size of the ML storage volume that you want to provision.
`String`	`toString()` Returns a string representation of this object.
`ResourceConfig`	`withInstanceCount(Integer instanceCount)` The number of ML compute instances to use.
`ResourceConfig`	`withInstanceType(String instanceType)` The ML compute instance type.
`ResourceConfig`	`withInstanceType(TrainingInstanceType instanceType)` The ML compute instance type.
`ResourceConfig`	`withVolumeKmsKeyId(String volumeKmsKeyId)` 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 training job.
`ResourceConfig`	`withVolumeSizeInGB(Integer volumeSizeInGB)` The size of the ML storage volume that you want to provision.

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

- Constructor Detail
  - ResourceConfig
```
public ResourceConfig()
```
- Method Detail
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The ML compute instance type.
    
    Parameters:
    
    instanceType - The ML compute instance type.
    
    See Also:
    
    TrainingInstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The ML compute instance type.
    
    Returns:
    
    The ML compute instance type.
    
    See Also:
    
    TrainingInstanceType
  - withInstanceType
```
public ResourceConfig withInstanceType(String instanceType)
```
    The ML compute instance type.
    
    Parameters:
    
    instanceType - The ML compute instance type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingInstanceType
  - withInstanceType
```
public ResourceConfig withInstanceType(TrainingInstanceType instanceType)
```
    The ML compute instance type.
    
    Parameters:
    
    instanceType - The ML compute instance type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TrainingInstanceType
  - setInstanceCount
```
public void setInstanceCount(Integer instanceCount)
```
    The number of ML compute instances to use. For distributed training, provide a value greater than 1.
    
    Parameters:
    
    instanceCount - The number of ML compute instances to use. For distributed training, provide a value greater than 1.
  - getInstanceCount
```
public Integer getInstanceCount()
```
    The number of ML compute instances to use. For distributed training, provide a value greater than 1.
    
    Returns:
    
    The number of ML compute instances to use. For distributed training, provide a value greater than 1.
  - withInstanceCount
```
public ResourceConfig withInstanceCount(Integer instanceCount)
```
    The number of ML compute instances to use. For distributed training, provide a value greater than 1.
    
    Parameters:
    
    instanceCount - The number of ML compute instances to use. For distributed training, provide a value greater than 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeSizeInGB
```
public void setVolumeSizeInGB(Integer volumeSizeInGB)
```
    The size of the ML storage volume that you want to provision.
    
    ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
    
    You must specify sufficient ML storage for your scenario.
    
    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
    
    Parameters:
    
    volumeSizeInGB - The size of the ML storage volume that you want to provision.
    
    ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
    
    You must specify sufficient ML storage for your scenario.
    
    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
  - getVolumeSizeInGB
```
public Integer getVolumeSizeInGB()
```
    The size of the ML storage volume that you want to provision.
    
    ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
    
    You must specify sufficient ML storage for your scenario.
    
    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
    
    Returns:
    
    The size of the ML storage volume that you want to provision.
    
    ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
    
    You must specify sufficient ML storage for your scenario.
    
    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
  - withVolumeSizeInGB
```
public ResourceConfig withVolumeSizeInGB(Integer volumeSizeInGB)
```
    The size of the ML storage volume that you want to provision.
    
    ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
    
    You must specify sufficient ML storage for your scenario.
    
    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
    
    Parameters:
    
    volumeSizeInGB - The size of the ML storage volume that you want to provision.
    
    ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.
    
    You must specify sufficient ML storage for your scenario.
    
    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeKmsKeyId
```
public void setVolumeKmsKeyId(String volumeKmsKeyId)
```
    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 training job. The VolumeKmsKeyId can be any of the following formats:
    - // KMS Key ID
      
      "1234abcd-12ab-34cd-56ef-1234567890ab"
    - // Amazon Resource Name (ARN) of a KMS Key
      
      "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Parameters:
    volumeKmsKeyId - 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 training job. The VolumeKmsKeyId can be any of the following formats:
    
    // KMS Key ID
    
    "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    // Amazon Resource Name (ARN) of a KMS Key
    
    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  - getVolumeKmsKeyId
```
public 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 training job. The VolumeKmsKeyId can be any of the following formats:
    - // KMS Key ID
      
      "1234abcd-12ab-34cd-56ef-1234567890ab"
    - // Amazon Resource Name (ARN) of a KMS Key
      
      "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Returns:
    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 training job. The VolumeKmsKeyId can be any of the following formats:
    
    // KMS Key ID
    
    "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    // Amazon Resource Name (ARN) of a KMS Key
    
    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
  - withVolumeKmsKeyId
```
public ResourceConfig withVolumeKmsKeyId(String volumeKmsKeyId)
```
    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 training job. The VolumeKmsKeyId can be any of the following formats:
    - // KMS Key ID
      
      "1234abcd-12ab-34cd-56ef-1234567890ab"
    - // Amazon Resource Name (ARN) of a KMS Key
      
      "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    Parameters:
    volumeKmsKeyId - 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 training job. The VolumeKmsKeyId can be any of the following formats:
    
    // KMS Key ID
    
    "1234abcd-12ab-34cd-56ef-1234567890ab"
    
    // Amazon Resource Name (ARN) of a KMS Key
    
    "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    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 ResourceConfig 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.

Did this page help you?

Class ResourceConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResourceConfig

Method Detail

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setInstanceCount

getInstanceCount

withInstanceCount

setVolumeSizeInGB

getVolumeSizeInGB

withVolumeSizeInGB

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

toString

equals

hashCode

clone

marshall