com.amazonaws.services.sagemaker.model.ResourceConfig Maven / Gradle / Ivy
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes the resources, including ML compute instances and ML storage volumes, to use for model training.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ResourceConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ML compute instance type.
*
*/
private String instanceType;
/**
*
* The number of ML compute instances to use. For distributed training, provide a value greater than 1.
*
*/
private Integer instanceCount;
/**
*
* 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.
*
*
*
* Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When
* using these instances for training, 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.
*
*
*/
private Integer volumeSizeInGB;
/**
*
* The 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.
*
*
*
* 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 in 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"
*
*
*
*/
private String volumeKmsKeyId;
/**
*
* The ML compute instance type.
*
*
* @param instanceType
* The ML compute instance type.
* @see TrainingInstanceType
*/
public void setInstanceType(String instanceType) {
this.instanceType = instanceType;
}
/**
*
* The ML compute instance type.
*
*
* @return The ML compute instance type.
* @see TrainingInstanceType
*/
public String getInstanceType() {
return this.instanceType;
}
/**
*
* The ML compute instance type.
*
*
* @param instanceType
* The ML compute instance type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingInstanceType
*/
public ResourceConfig withInstanceType(String instanceType) {
setInstanceType(instanceType);
return this;
}
/**
*
* The ML compute instance type.
*
*
* @param instanceType
* The ML compute instance type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingInstanceType
*/
public ResourceConfig withInstanceType(TrainingInstanceType instanceType) {
this.instanceType = instanceType.toString();
return this;
}
/**
*
* The number of ML compute instances to use. For distributed training, provide a value greater than 1.
*
*
* @param instanceCount
* The number of ML compute instances to use. For distributed training, provide a value greater than 1.
*/
public void setInstanceCount(Integer instanceCount) {
this.instanceCount = instanceCount;
}
/**
*
* The number of ML compute instances to use. For distributed training, provide a value greater than 1.
*
*
* @return The number of ML compute instances to use. For distributed training, provide a value greater than 1.
*/
public Integer getInstanceCount() {
return this.instanceCount;
}
/**
*
* The number of ML compute instances to use. For distributed training, provide a value greater than 1.
*
*
* @param instanceCount
* The number of ML compute instances to use. For distributed training, provide a value greater than 1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceConfig withInstanceCount(Integer instanceCount) {
setInstanceCount(instanceCount);
return this;
}
/**
*
* 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.
*
*
*
* Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When
* using these instances for training, 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.
*
*
*
* @param 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.
*
*
*
* Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance
* type. When using these instances for training, 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.
*
*/
public void setVolumeSizeInGB(Integer volumeSizeInGB) {
this.volumeSizeInGB = 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.
*
*
*
* Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When
* using these instances for training, 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.
*
*
*
* @return 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.
*
*
*
* Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance
* type. When using these instances for training, 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.
*
*/
public Integer getVolumeSizeInGB() {
return this.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.
*
*
*
* Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When
* using these instances for training, 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.
*
*
*
* @param 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.
*
*
*
* Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance
* type. When using these instances for training, 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceConfig withVolumeSizeInGB(Integer volumeSizeInGB) {
setVolumeSizeInGB(volumeSizeInGB);
return this;
}
/**
*
* The 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.
*
*
*
* 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 in 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"
*
*
*
*
* @param volumeKmsKeyId
* The 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.
*
* 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 in 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"
*
*
*/
public void setVolumeKmsKeyId(String volumeKmsKeyId) {
this.volumeKmsKeyId = volumeKmsKeyId;
}
/**
*
* The 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.
*
*
*
* 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 in 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"
*
*
*
*
* @return The 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.
*
* 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 in 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"
*
*
*/
public String getVolumeKmsKeyId() {
return this.volumeKmsKeyId;
}
/**
*
* The 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.
*
*
*
* 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 in 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"
*
*
*
*
* @param volumeKmsKeyId
* The 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.
*
* 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 in 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"
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ResourceConfig withVolumeKmsKeyId(String volumeKmsKeyId) {
setVolumeKmsKeyId(volumeKmsKeyId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInstanceType() != null)
sb.append("InstanceType: ").append(getInstanceType()).append(",");
if (getInstanceCount() != null)
sb.append("InstanceCount: ").append(getInstanceCount()).append(",");
if (getVolumeSizeInGB() != null)
sb.append("VolumeSizeInGB: ").append(getVolumeSizeInGB()).append(",");
if (getVolumeKmsKeyId() != null)
sb.append("VolumeKmsKeyId: ").append(getVolumeKmsKeyId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ResourceConfig == false)
return false;
ResourceConfig other = (ResourceConfig) obj;
if (other.getInstanceType() == null ^ this.getInstanceType() == null)
return false;
if (other.getInstanceType() != null && other.getInstanceType().equals(this.getInstanceType()) == false)
return false;
if (other.getInstanceCount() == null ^ this.getInstanceCount() == null)
return false;
if (other.getInstanceCount() != null && other.getInstanceCount().equals(this.getInstanceCount()) == false)
return false;
if (other.getVolumeSizeInGB() == null ^ this.getVolumeSizeInGB() == null)
return false;
if (other.getVolumeSizeInGB() != null && other.getVolumeSizeInGB().equals(this.getVolumeSizeInGB()) == false)
return false;
if (other.getVolumeKmsKeyId() == null ^ this.getVolumeKmsKeyId() == null)
return false;
if (other.getVolumeKmsKeyId() != null && other.getVolumeKmsKeyId().equals(this.getVolumeKmsKeyId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceType() == null) ? 0 : getInstanceType().hashCode());
hashCode = prime * hashCode + ((getInstanceCount() == null) ? 0 : getInstanceCount().hashCode());
hashCode = prime * hashCode + ((getVolumeSizeInGB() == null) ? 0 : getVolumeSizeInGB().hashCode());
hashCode = prime * hashCode + ((getVolumeKmsKeyId() == null) ? 0 : getVolumeKmsKeyId().hashCode());
return hashCode;
}
@Override
public ResourceConfig clone() {
try {
return (ResourceConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.sagemaker.model.transform.ResourceConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}