/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace SageMaker { namespace Model { /** *

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

See Also:

AWS * API Reference

*/ class AWS_SAGEMAKER_API ResourceConfig { public: ResourceConfig(); ResourceConfig(Aws::Utils::Json::JsonView jsonValue); ResourceConfig& operator=(Aws::Utils::Json::JsonView jsonValue); Aws::Utils::Json::JsonValue Jsonize() const; /** *

The ML compute instance type.

*/ inline const TrainingInstanceType& GetInstanceType() const{ return m_instanceType; } /** *

The ML compute instance type.

*/ inline bool InstanceTypeHasBeenSet() const { return m_instanceTypeHasBeenSet; } /** *

The ML compute instance type.

*/ inline void SetInstanceType(const TrainingInstanceType& value) { m_instanceTypeHasBeenSet = true; m_instanceType = value; } /** *

The ML compute instance type.

*/ inline void SetInstanceType(TrainingInstanceType&& value) { m_instanceTypeHasBeenSet = true; m_instanceType = std::move(value); } /** *

The ML compute instance type.

*/ inline ResourceConfig& WithInstanceType(const TrainingInstanceType& value) { SetInstanceType(value); return *this;} /** *

The ML compute instance type.

*/ inline ResourceConfig& WithInstanceType(TrainingInstanceType&& value) { SetInstanceType(std::move(value)); return *this;} /** *

The number of ML compute instances to use. For distributed training, provide * a value greater than 1.

*/ inline int GetInstanceCount() const{ return m_instanceCount; } /** *

The number of ML compute instances to use. For distributed training, provide * a value greater than 1.

*/ inline bool InstanceCountHasBeenSet() const { return m_instanceCountHasBeenSet; } /** *

The number of ML compute instances to use. For distributed training, provide * a value greater than 1.

*/ inline void SetInstanceCount(int value) { m_instanceCountHasBeenSet = true; m_instanceCount = value; } /** *

The number of ML compute instances to use. For distributed training, provide * a value greater than 1.

*/ inline ResourceConfig& WithInstanceCount(int value) { SetInstanceCount(value); 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.

*/ inline int GetVolumeSizeInGB() const{ return m_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.

*/ inline bool VolumeSizeInGBHasBeenSet() const { return m_volumeSizeInGBHasBeenSet; } /** *

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.

*/ inline void SetVolumeSizeInGB(int value) { m_volumeSizeInGBHasBeenSet = true; m_volumeSizeInGB = value; } /** *

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.

*/ inline ResourceConfig& WithVolumeSizeInGB(int value) { SetVolumeSizeInGB(value); 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" *

*/ inline const Aws::String& GetVolumeKmsKeyId() const{ return m_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" *

*/ inline bool VolumeKmsKeyIdHasBeenSet() const { return m_volumeKmsKeyIdHasBeenSet; } /** *

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

*/ inline void SetVolumeKmsKeyId(const Aws::String& value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId = value; } /** *

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

*/ inline void SetVolumeKmsKeyId(Aws::String&& value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId = std::move(value); } /** *

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

*/ inline void SetVolumeKmsKeyId(const char* value) { m_volumeKmsKeyIdHasBeenSet = true; m_volumeKmsKeyId.assign(value); } /** *

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

*/ inline ResourceConfig& WithVolumeKmsKeyId(const Aws::String& value) { SetVolumeKmsKeyId(value); 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" *

*/ inline ResourceConfig& WithVolumeKmsKeyId(Aws::String&& value) { SetVolumeKmsKeyId(std::move(value)); 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" *

*/ inline ResourceConfig& WithVolumeKmsKeyId(const char* value) { SetVolumeKmsKeyId(value); return *this;} private: TrainingInstanceType m_instanceType; bool m_instanceTypeHasBeenSet; int m_instanceCount; bool m_instanceCountHasBeenSet; int m_volumeSizeInGB; bool m_volumeSizeInGBHasBeenSet; Aws::String m_volumeKmsKeyId; bool m_volumeKmsKeyIdHasBeenSet; }; } // namespace Model } // namespace SageMaker } // namespace Aws