Struct CapacityLimit

#[non_exhaustive]
pub struct CapacityLimit {
    pub max_capacity: Option<i32>,
    pub capacity_unit: Option<String>,
}

Defines the capacity limit for a service environment. This structure specifies the maximum amount of resources that can be used by service jobs in the environment.

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.

max_capacity: Option<i32>

The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.

For example, maxCapacity=50, capacityUnit=NUM_INSTANCES. This indicates that the maximum number of instances that can be run on this service environment is 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that requires 10 instances, it will wait in the queue.

capacity_unit: Option<String>

The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For SAGEMAKER_TRAINING jobs, use NUM_INSTANCES.

Implementations

impl CapacityLimit

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

The maximum capacity available for the service environment. This value represents the maximum amount of resources that can be allocated to service jobs.

For example, maxCapacity=50, capacityUnit=NUM_INSTANCES. This indicates that the maximum number of instances that can be run on this service environment is 50. You could then run 5 SageMaker Training jobs that each use 10 instances. However, if you submit another job that requires 10 instances, it will wait in the queue.

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

The unit of measure for the capacity limit. This defines how the maxCapacity value should be interpreted. For SAGEMAKER_TRAINING jobs, use NUM_INSTANCES.

impl CapacityLimit

pub fn builder() -> CapacityLimitBuilder

Creates a new builder-style object to manufacture CapacityLimit.

Trait Implementations

impl Clone for CapacityLimit

fn clone(&self) -> CapacityLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapacityLimit

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

Formats the value using the given formatter.

impl PartialEq for CapacityLimit

fn eq(&self, other: &CapacityLimit) -> 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 CapacityLimit