AWS SDK for C++  1.9.159
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::ResourceConfig Class Reference

#include <ResourceConfig.h>

Public Member Functions

 ResourceConfig ()
 
 ResourceConfig (Aws::Utils::Json::JsonView jsonValue)
 
ResourceConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const TrainingInstanceTypeGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const TrainingInstanceType &value)
 
void SetInstanceType (TrainingInstanceType &&value)
 
ResourceConfigWithInstanceType (const TrainingInstanceType &value)
 
ResourceConfigWithInstanceType (TrainingInstanceType &&value)
 
int GetInstanceCount () const
 
bool InstanceCountHasBeenSet () const
 
void SetInstanceCount (int value)
 
ResourceConfigWithInstanceCount (int value)
 
int GetVolumeSizeInGB () const
 
bool VolumeSizeInGBHasBeenSet () const
 
void SetVolumeSizeInGB (int value)
 
ResourceConfigWithVolumeSizeInGB (int value)
 
const Aws::StringGetVolumeKmsKeyId () const
 
bool VolumeKmsKeyIdHasBeenSet () const
 
void SetVolumeKmsKeyId (const Aws::String &value)
 
void SetVolumeKmsKeyId (Aws::String &&value)
 
void SetVolumeKmsKeyId (const char *value)
 
ResourceConfigWithVolumeKmsKeyId (const Aws::String &value)
 
ResourceConfigWithVolumeKmsKeyId (Aws::String &&value)
 
ResourceConfigWithVolumeKmsKeyId (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 33 of file ResourceConfig.h.

Constructor & Destructor Documentation

◆ ResourceConfig() [1/2]

Aws::SageMaker::Model::ResourceConfig::ResourceConfig ( )

◆ ResourceConfig() [2/2]

Aws::SageMaker::Model::ResourceConfig::ResourceConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetInstanceCount()

int Aws::SageMaker::Model::ResourceConfig::GetInstanceCount ( ) const
inline

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

Definition at line 77 of file ResourceConfig.h.

◆ GetInstanceType()

const TrainingInstanceType& Aws::SageMaker::Model::ResourceConfig::GetInstanceType ( ) const
inline

The ML compute instance type.

Definition at line 45 of file ResourceConfig.h.

◆ GetVolumeKmsKeyId()

const Aws::String& Aws::SageMaker::Model::ResourceConfig::GetVolumeKmsKeyId ( ) const
inline

The Amazon Web Services 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"

Definition at line 198 of file ResourceConfig.h.

◆ GetVolumeSizeInGB()

int Aws::SageMaker::Model::ResourceConfig::GetVolumeSizeInGB ( ) const
inline

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.

Definition at line 116 of file ResourceConfig.h.

◆ InstanceCountHasBeenSet()

bool Aws::SageMaker::Model::ResourceConfig::InstanceCountHasBeenSet ( ) const
inline

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

Definition at line 83 of file ResourceConfig.h.

◆ InstanceTypeHasBeenSet()

bool Aws::SageMaker::Model::ResourceConfig::InstanceTypeHasBeenSet ( ) const
inline

The ML compute instance type.

Definition at line 50 of file ResourceConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SageMaker::Model::ResourceConfig::Jsonize ( ) const

◆ operator=()

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetInstanceCount()

void Aws::SageMaker::Model::ResourceConfig::SetInstanceCount ( int  value)
inline

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

Definition at line 89 of file ResourceConfig.h.

◆ SetInstanceType() [1/2]

void Aws::SageMaker::Model::ResourceConfig::SetInstanceType ( const TrainingInstanceType value)
inline

The ML compute instance type.

Definition at line 55 of file ResourceConfig.h.

◆ SetInstanceType() [2/2]

void Aws::SageMaker::Model::ResourceConfig::SetInstanceType ( TrainingInstanceType &&  value)
inline

The ML compute instance type.

Definition at line 60 of file ResourceConfig.h.

◆ SetVolumeKmsKeyId() [1/3]

void Aws::SageMaker::Model::ResourceConfig::SetVolumeKmsKeyId ( Aws::String &&  value)
inline

The Amazon Web Services 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"

Definition at line 261 of file ResourceConfig.h.

◆ SetVolumeKmsKeyId() [2/3]

void Aws::SageMaker::Model::ResourceConfig::SetVolumeKmsKeyId ( const Aws::String value)
inline

The Amazon Web Services 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"

Definition at line 240 of file ResourceConfig.h.

◆ SetVolumeKmsKeyId() [3/3]

void Aws::SageMaker::Model::ResourceConfig::SetVolumeKmsKeyId ( const char *  value)
inline

The Amazon Web Services 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"

Definition at line 282 of file ResourceConfig.h.

◆ SetVolumeSizeInGB()

void Aws::SageMaker::Model::ResourceConfig::SetVolumeSizeInGB ( int  value)
inline

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.

Definition at line 156 of file ResourceConfig.h.

◆ VolumeKmsKeyIdHasBeenSet()

bool Aws::SageMaker::Model::ResourceConfig::VolumeKmsKeyIdHasBeenSet ( ) const
inline

The Amazon Web Services 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"

Definition at line 219 of file ResourceConfig.h.

◆ VolumeSizeInGBHasBeenSet()

bool Aws::SageMaker::Model::ResourceConfig::VolumeSizeInGBHasBeenSet ( ) const
inline

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.

Definition at line 136 of file ResourceConfig.h.

◆ WithInstanceCount()

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::WithInstanceCount ( int  value)
inline

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

Definition at line 95 of file ResourceConfig.h.

◆ WithInstanceType() [1/2]

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::WithInstanceType ( const TrainingInstanceType value)
inline

The ML compute instance type.

Definition at line 65 of file ResourceConfig.h.

◆ WithInstanceType() [2/2]

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::WithInstanceType ( TrainingInstanceType &&  value)
inline

The ML compute instance type.

Definition at line 70 of file ResourceConfig.h.

◆ WithVolumeKmsKeyId() [1/3]

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::WithVolumeKmsKeyId ( Aws::String &&  value)
inline

The Amazon Web Services 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"

Definition at line 324 of file ResourceConfig.h.

◆ WithVolumeKmsKeyId() [2/3]

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::WithVolumeKmsKeyId ( const Aws::String value)
inline

The Amazon Web Services 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"

Definition at line 303 of file ResourceConfig.h.

◆ WithVolumeKmsKeyId() [3/3]

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::WithVolumeKmsKeyId ( const char *  value)
inline

The Amazon Web Services 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"

Definition at line 345 of file ResourceConfig.h.

◆ WithVolumeSizeInGB()

ResourceConfig& Aws::SageMaker::Model::ResourceConfig::WithVolumeSizeInGB ( int  value)
inline

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.

Definition at line 176 of file ResourceConfig.h.


The documentation for this class was generated from the following file: