software.amazon.awssdk.services.sagemaker.model

Class ResourceConfig

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.ResourceConfig

All Implemented Interfaces:

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

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

Describes the resources, including ML compute instances and ML storage volumes, to use for model training.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ResourceConfig.Builder

Method Summary

Modifier and Type	Method and Description
static ResourceConfig.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	instanceCount() The number of ML compute instances to use.
TrainingInstanceType	instanceType() The ML compute instance type.
String	instanceTypeAsString() The ML compute instance type.
List<SdkField<?>>	sdkFields()
static Class<? extends ResourceConfig.Builder>	serializableBuilderClass()
ResourceConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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.
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

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

copy

Method Detail

instanceType

public TrainingInstanceType instanceType()

The ML compute instance type.

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

Returns:

The ML compute instance type.

See Also:

TrainingInstanceType

instanceTypeAsString

public String instanceTypeAsString()

The ML compute instance type.

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

Returns:

The ML compute instance type.

See Also:

TrainingInstanceType

instanceCount

public Integer instanceCount()

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.

volumeSizeInGB

public 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.

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.

volumeKmsKeyId

public 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"

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"

toBuilder

public ResourceConfig.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ResourceConfig.Builder,ResourceConfig>

Returns:

a builder for type T

builder

public static ResourceConfig.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.