Class TransformResources
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.TransformResources
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TransformResources.Builder,TransformResources>
@Generated("software.amazon.awssdk:codegen") public final class TransformResources extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TransformResources.Builder,TransformResources>
Describes the resources, including ML instance types and ML instance count, to use for transform job.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TransformResources.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TransformResources.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 transform job.TransformInstanceType
instanceType()
The ML compute instance type for the transform job.String
instanceTypeAsString()
The ML compute instance type for the transform job.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends TransformResources.Builder>
serializableBuilderClass()
TransformResources.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 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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
instanceType
public final 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.large
instance types.If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnTransformInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- 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.large
instance types. - See Also:
TransformInstanceType
-
instanceTypeAsString
public final String instanceTypeAsString()
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.large
instance types.If the service returns an enum value that is not available in the current SDK version,
instanceType
will returnTransformInstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- 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.large
instance types. - See Also:
TransformInstanceType
-
instanceCount
public final Integer instanceCount()
The number of ML compute instances to use in the transform job. The default value is
1
, and the maximum is100
. For distributed transform jobs, specify a value greater than1
.- Returns:
- The number of ML compute instances to use in the transform job. The default value is
1
, and the maximum is100
. For distributed transform jobs, specify a value greater than1
.
-
volumeKmsKeyId
public final 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
- 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
-
-
-
toBuilder
public TransformResources.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<TransformResources.Builder,TransformResources>
-
builder
public static TransformResources.Builder builder()
-
serializableBuilderClass
public static Class<? extends TransformResources.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-