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

#include <ProcessingClusterConfig.h>

Public Member Functions

 ProcessingClusterConfig ()
 
 ProcessingClusterConfig (Aws::Utils::Json::JsonView jsonValue)
 
ProcessingClusterConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetInstanceCount () const
 
bool InstanceCountHasBeenSet () const
 
void SetInstanceCount (int value)
 
ProcessingClusterConfigWithInstanceCount (int value)
 
const ProcessingInstanceTypeGetInstanceType () const
 
bool InstanceTypeHasBeenSet () const
 
void SetInstanceType (const ProcessingInstanceType &value)
 
void SetInstanceType (ProcessingInstanceType &&value)
 
ProcessingClusterConfigWithInstanceType (const ProcessingInstanceType &value)
 
ProcessingClusterConfigWithInstanceType (ProcessingInstanceType &&value)
 
int GetVolumeSizeInGB () const
 
bool VolumeSizeInGBHasBeenSet () const
 
void SetVolumeSizeInGB (int value)
 
ProcessingClusterConfigWithVolumeSizeInGB (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)
 
ProcessingClusterConfigWithVolumeKmsKeyId (const Aws::String &value)
 
ProcessingClusterConfigWithVolumeKmsKeyId (Aws::String &&value)
 
ProcessingClusterConfigWithVolumeKmsKeyId (const char *value)
 

Detailed Description

Configuration for the cluster used to run a processing job.

See Also:

AWS API Reference

Definition at line 33 of file ProcessingClusterConfig.h.

Constructor & Destructor Documentation

◆ ProcessingClusterConfig() [1/2]

Aws::SageMaker::Model::ProcessingClusterConfig::ProcessingClusterConfig ( )

◆ ProcessingClusterConfig() [2/2]

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

Member Function Documentation

◆ GetInstanceCount()

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

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

Definition at line 47 of file ProcessingClusterConfig.h.

◆ GetInstanceType()

const ProcessingInstanceType& Aws::SageMaker::Model::ProcessingClusterConfig::GetInstanceType ( ) const
inline

The ML compute instance type for the processing job.

Definition at line 74 of file ProcessingClusterConfig.h.

◆ GetVolumeKmsKeyId()

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 174 of file ProcessingClusterConfig.h.

◆ GetVolumeSizeInGB()

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

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, 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 114 of file ProcessingClusterConfig.h.

◆ InstanceCountHasBeenSet()

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

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

Definition at line 54 of file ProcessingClusterConfig.h.

◆ InstanceTypeHasBeenSet()

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

The ML compute instance type for the processing job.

Definition at line 79 of file ProcessingClusterConfig.h.

◆ Jsonize()

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

◆ operator=()

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

◆ SetInstanceCount()

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

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

Definition at line 61 of file ProcessingClusterConfig.h.

◆ SetInstanceType() [1/2]

void Aws::SageMaker::Model::ProcessingClusterConfig::SetInstanceType ( const ProcessingInstanceType value)
inline

The ML compute instance type for the processing job.

Definition at line 84 of file ProcessingClusterConfig.h.

◆ SetInstanceType() [2/2]

void Aws::SageMaker::Model::ProcessingClusterConfig::SetInstanceType ( ProcessingInstanceType &&  value)
inline

The ML compute instance type for the processing job.

Definition at line 89 of file ProcessingClusterConfig.h.

◆ SetVolumeKmsKeyId() [1/3]

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 225 of file ProcessingClusterConfig.h.

◆ SetVolumeKmsKeyId() [2/3]

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 208 of file ProcessingClusterConfig.h.

◆ SetVolumeKmsKeyId() [3/3]

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 242 of file ProcessingClusterConfig.h.

◆ SetVolumeSizeInGB()

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

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, 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 142 of file ProcessingClusterConfig.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 191 of file ProcessingClusterConfig.h.

◆ VolumeSizeInGBHasBeenSet()

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

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, 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 128 of file ProcessingClusterConfig.h.

◆ WithInstanceCount()

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

The number of ML compute instances to use in the processing job. For distributed processing jobs, specify a value greater than 1. The default value is 1.

Definition at line 68 of file ProcessingClusterConfig.h.

◆ WithInstanceType() [1/2]

ProcessingClusterConfig& Aws::SageMaker::Model::ProcessingClusterConfig::WithInstanceType ( const ProcessingInstanceType value)
inline

The ML compute instance type for the processing job.

Definition at line 94 of file ProcessingClusterConfig.h.

◆ WithInstanceType() [2/2]

ProcessingClusterConfig& Aws::SageMaker::Model::ProcessingClusterConfig::WithInstanceType ( ProcessingInstanceType &&  value)
inline

The ML compute instance type for the processing job.

Definition at line 99 of file ProcessingClusterConfig.h.

◆ WithVolumeKmsKeyId() [1/3]

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 276 of file ProcessingClusterConfig.h.

◆ WithVolumeKmsKeyId() [2/3]

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 259 of file ProcessingClusterConfig.h.

◆ WithVolumeKmsKeyId() [3/3]

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

The Amazon Web Services Key Management Service (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 processing 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.

Definition at line 293 of file ProcessingClusterConfig.h.

◆ WithVolumeSizeInGB()

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

The size of the ML storage volume in gigabytes that you want to provision. You must specify sufficient ML storage for your scenario.

Certain Nitro-based instances include local storage with a fixed total size, dependent on the instance type. When using these instances for processing, 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 ProcessingClusterConfig.h.


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