Struct aws_sdk_ecs::types::builders::CapacityProviderStrategyItemBuilder

#[non_exhaustive]
pub struct CapacityProviderStrategyItemBuilder { /* private fields */ }

A builder for CapacityProviderStrategyItem.

Implementations

impl CapacityProviderStrategyItemBuilder

pub fn capacity_provider(self, input: impl Into<String>) -> Self

The short name of the capacity provider.

This field is required.

pub fn set_capacity_provider(self, input: Option<String>) -> Self

The short name of the capacity provider.

pub fn get_capacity_provider(&self) -> &Option<String>

The short name of the capacity provider.

pub fn weight(self, input: i32) -> Self

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

pub fn set_weight(self, input: Option<i32>) -> Self

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

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

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

pub fn base(self, input: i32) -> Self

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

pub fn set_base(self, input: Option<i32>) -> Self

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

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

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

pub fn build(self) -> Result<CapacityProviderStrategyItem, BuildError>

Consumes the builder and constructs a CapacityProviderStrategyItem. This method will fail if any of the following fields are not set:

• capacity_provider

Trait Implementations

impl Clone for CapacityProviderStrategyItemBuilder

fn clone(&self) -> CapacityProviderStrategyItemBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CapacityProviderStrategyItemBuilder

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

Formats the value using the given formatter.

impl Default for CapacityProviderStrategyItemBuilder

fn default() -> CapacityProviderStrategyItemBuilder

Returns the “default value” for a type.

impl PartialEq for CapacityProviderStrategyItemBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CapacityProviderStrategyItemBuilder