Struct ProcessingClusterConfig

#[non_exhaustive]
pub struct ProcessingClusterConfig {
    pub instance_count: Option<i32>,
    pub instance_type: Option<ProcessingInstanceType>,
    pub volume_size_in_gb: Option<i32>,
    pub volume_kms_key_id: Option<String>,
}

Configuration for the cluster used to run a processing job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

instance_count: Option<i32>

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.

instance_type: Option<ProcessingInstanceType>

The ML compute instance type for the processing job.

volume_size_in_gb: Option<i32>

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.

volume_kms_key_id: Option<String>

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.

Implementations

impl ProcessingClusterConfig

pub fn instance_count(&self) -> Option<i32>

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.

pub fn instance_type(&self) -> Option<&ProcessingInstanceType>

The ML compute instance type for the processing job.

pub fn volume_size_in_gb(&self) -> Option<i32>

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.

pub fn volume_kms_key_id(&self) -> Option<&str>

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.

impl ProcessingClusterConfig

pub fn builder() -> ProcessingClusterConfigBuilder

Creates a new builder-style object to manufacture ProcessingClusterConfig.

Trait Implementations

impl Clone for ProcessingClusterConfig

fn clone(&self) -> ProcessingClusterConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProcessingClusterConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ProcessingClusterConfig

fn eq(&self, other: &ProcessingClusterConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ProcessingClusterConfig