AWS SDK for C++  1.8.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::CapacityProviderStrategyItem Class Reference

#include <CapacityProviderStrategyItem.h>

Public Member Functions

 CapacityProviderStrategyItem ()
 
 CapacityProviderStrategyItem (Aws::Utils::Json::JsonView jsonValue)
 
CapacityProviderStrategyItemoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCapacityProvider () const
 
bool CapacityProviderHasBeenSet () const
 
void SetCapacityProvider (const Aws::String &value)
 
void SetCapacityProvider (Aws::String &&value)
 
void SetCapacityProvider (const char *value)
 
CapacityProviderStrategyItemWithCapacityProvider (const Aws::String &value)
 
CapacityProviderStrategyItemWithCapacityProvider (Aws::String &&value)
 
CapacityProviderStrategyItemWithCapacityProvider (const char *value)
 
int GetWeight () const
 
bool WeightHasBeenSet () const
 
void SetWeight (int value)
 
CapacityProviderStrategyItemWithWeight (int value)
 
int GetBase () const
 
bool BaseHasBeenSet () const
 
void SetBase (int value)
 
CapacityProviderStrategyItemWithBase (int value)
 

Detailed Description

The details of a capacity provider strategy.

See Also:

AWS API Reference

Definition at line 31 of file CapacityProviderStrategyItem.h.

Constructor & Destructor Documentation

◆ CapacityProviderStrategyItem() [1/2]

Aws::ECS::Model::CapacityProviderStrategyItem::CapacityProviderStrategyItem ( )

◆ CapacityProviderStrategyItem() [2/2]

Aws::ECS::Model::CapacityProviderStrategyItem::CapacityProviderStrategyItem ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BaseHasBeenSet()

bool Aws::ECS::Model::CapacityProviderStrategyItem::BaseHasBeenSet ( ) const
inline

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.

Definition at line 146 of file CapacityProviderStrategyItem.h.

◆ CapacityProviderHasBeenSet()

bool Aws::ECS::Model::CapacityProviderStrategyItem::CapacityProviderHasBeenSet ( ) const
inline

The short name of the capacity provider.

Definition at line 48 of file CapacityProviderStrategyItem.h.

◆ GetBase()

int Aws::ECS::Model::CapacityProviderStrategyItem::GetBase ( ) const
inline

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.

Definition at line 139 of file CapacityProviderStrategyItem.h.

◆ GetCapacityProvider()

const Aws::String& Aws::ECS::Model::CapacityProviderStrategyItem::GetCapacityProvider ( ) const
inline

The short name of the capacity provider.

Definition at line 43 of file CapacityProviderStrategyItem.h.

◆ GetWeight()

int Aws::ECS::Model::CapacityProviderStrategyItem::GetWeight ( ) const
inline

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

For example, if you have 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 is run using capacityProviderA, four tasks would use capacityProviderB.

Definition at line 92 of file CapacityProviderStrategyItem.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ECS::Model::CapacityProviderStrategyItem::Jsonize ( ) const

◆ operator=()

CapacityProviderStrategyItem& Aws::ECS::Model::CapacityProviderStrategyItem::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetBase()

void Aws::ECS::Model::CapacityProviderStrategyItem::SetBase ( int  value)
inline

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.

Definition at line 153 of file CapacityProviderStrategyItem.h.

◆ SetCapacityProvider() [1/3]

void Aws::ECS::Model::CapacityProviderStrategyItem::SetCapacityProvider ( const Aws::String value)
inline

The short name of the capacity provider.

Definition at line 53 of file CapacityProviderStrategyItem.h.

◆ SetCapacityProvider() [2/3]

void Aws::ECS::Model::CapacityProviderStrategyItem::SetCapacityProvider ( Aws::String &&  value)
inline

The short name of the capacity provider.

Definition at line 58 of file CapacityProviderStrategyItem.h.

◆ SetCapacityProvider() [3/3]

void Aws::ECS::Model::CapacityProviderStrategyItem::SetCapacityProvider ( const char *  value)
inline

The short name of the capacity provider.

Definition at line 63 of file CapacityProviderStrategyItem.h.

◆ SetWeight()

void Aws::ECS::Model::CapacityProviderStrategyItem::SetWeight ( int  value)
inline

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

For example, if you have 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 is run using capacityProviderA, four tasks would use capacityProviderB.

Definition at line 118 of file CapacityProviderStrategyItem.h.

◆ WeightHasBeenSet()

bool Aws::ECS::Model::CapacityProviderStrategyItem::WeightHasBeenSet ( ) const
inline

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

For example, if you have 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 is run using capacityProviderA, four tasks would use capacityProviderB.

Definition at line 105 of file CapacityProviderStrategyItem.h.

◆ WithBase()

CapacityProviderStrategyItem& Aws::ECS::Model::CapacityProviderStrategyItem::WithBase ( int  value)
inline

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.

Definition at line 160 of file CapacityProviderStrategyItem.h.

◆ WithCapacityProvider() [1/3]

CapacityProviderStrategyItem& Aws::ECS::Model::CapacityProviderStrategyItem::WithCapacityProvider ( const Aws::String value)
inline

The short name of the capacity provider.

Definition at line 68 of file CapacityProviderStrategyItem.h.

◆ WithCapacityProvider() [2/3]

CapacityProviderStrategyItem& Aws::ECS::Model::CapacityProviderStrategyItem::WithCapacityProvider ( Aws::String &&  value)
inline

The short name of the capacity provider.

Definition at line 73 of file CapacityProviderStrategyItem.h.

◆ WithCapacityProvider() [3/3]

CapacityProviderStrategyItem& Aws::ECS::Model::CapacityProviderStrategyItem::WithCapacityProvider ( const char *  value)
inline

The short name of the capacity provider.

Definition at line 78 of file CapacityProviderStrategyItem.h.

◆ WithWeight()

CapacityProviderStrategyItem& Aws::ECS::Model::CapacityProviderStrategyItem::WithWeight ( int  value)
inline

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

For example, if you have 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 is run using capacityProviderA, four tasks would use capacityProviderB.

Definition at line 131 of file CapacityProviderStrategyItem.h.


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