TransformResources (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TransformResources
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the resources, including ML instance types and ML instance count, to use for transform job.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TransformResources()

Constructors
Constructor and Description
`TransformResources()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransformResources`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getInstanceCount()` The number of ML compute instances to use in the transform job.
`String`	`getInstanceType()` The ML compute instance type for the transform job.
`String`	`getVolumeKmsKeyId()` The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.
`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 transform job.
`void`	`setInstanceType(String instanceType)` The ML compute instance type for the transform job.
`void`	`setVolumeKmsKeyId(String volumeKmsKeyId)` The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.
`String`	`toString()` Returns a string representation of this object.
`TransformResources`	`withInstanceCount(Integer instanceCount)` The number of ML compute instances to use in the transform job.
`TransformResources`	`withInstanceType(String instanceType)` The ML compute instance type for the transform job.
`TransformResources`	`withInstanceType(TransformInstanceType instanceType)` The ML compute instance type for the transform job.
`TransformResources`	`withVolumeKmsKeyId(String volumeKmsKeyId)` The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform job.

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

- Constructor Detail
  - TransformResources
```
public TransformResources()
```
- Method Detail
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    Parameters:
    
    instanceType - The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    See Also:
    
    TransformInstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    Returns:
    
    The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    See Also:
    
    TransformInstanceType
  - withInstanceType
```
public TransformResources withInstanceType(String instanceType)
```
    The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    Parameters:
    
    instanceType - The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransformInstanceType
  - withInstanceType
```
public TransformResources withInstanceType(TransformInstanceType instanceType)
```
    The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    Parameters:
    
    instanceType - The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.largeinstance types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransformInstanceType
  - setInstanceCount
```
public void setInstanceCount(Integer instanceCount)
```
    The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.
    
    Parameters:
    
    instanceCount - The number of ML compute instances to use in the transform job. For distributed transform 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 transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.
    
    Returns:
    
    The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.
  - withInstanceCount
```
public TransformResources withInstanceCount(Integer instanceCount)
```
    The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.
    
    Parameters:
    
    instanceCount - The number of ML compute instances to use in the transform job. For distributed transform 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.
  - setVolumeKmsKeyId
```
public void setVolumeKmsKeyId(String volumeKmsKeyId)
```
    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform 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.
    
    The VolumeKmsKeyId can be any of the following formats:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    Parameters:
    volumeKmsKeyId - The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform 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.
    
    The VolumeKmsKeyId can be any of the following formats:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
  - getVolumeKmsKeyId
```
public String getVolumeKmsKeyId()
```
    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform 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.
    
    The VolumeKmsKeyId can be any of the following formats:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    Returns:
    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform 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.
    
    The VolumeKmsKeyId can be any of the following formats:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
  - withVolumeKmsKeyId
```
public TransformResources withVolumeKmsKeyId(String volumeKmsKeyId)
```
    The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform 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.
    
    The VolumeKmsKeyId can be any of the following formats:
    - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    - Alias name: alias/ExampleAlias
    - Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    Parameters:
    volumeKmsKeyId - The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt model data on the storage volume attached to the ML compute instance(s) that run the batch transform 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.
    
    The VolumeKmsKeyId can be any of the following formats:
    
    Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    Alias name: alias/ExampleAlias
    
    Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
    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 TransformResources 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 TransformResources

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransformResources

Method Detail

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setInstanceCount

getInstanceCount

withInstanceCount

setVolumeKmsKeyId

getVolumeKmsKeyId

withVolumeKmsKeyId

toString

equals

hashCode

clone

marshall