/AWS1/CL_ECSCAPPVDRSTRAGITEM¶
The details of a capacity provider strategy. A capacity provider strategy can be set
when using the RunTaskor CreateCluster APIs or as the default capacity provider strategy for a
cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an
ACTIVE or UPDATING status can be used in a capacity
provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider
with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateClusterCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE or
FARGATE_SPOT capacity providers. The Fargate capacity providers
are available to all accounts and only need to be associated with a cluster to be used
in a capacity provider strategy.
With FARGATE_SPOT, you can run interruption tolerant tasks at a rate
that's discounted compared to the FARGATE price. FARGATE_SPOT
runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back,
your tasks are interrupted with a two-minute warning. FARGATE_SPOT supports
Linux tasks with the X86_64 architecture on platform version 1.3.0 or later.
FARGATE_SPOT supports Linux tasks with the ARM64 architecture on
platform version 1.4.0 or later.
A capacity provider strategy can contain a maximum of 20 capacity providers.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_capacityprovider TYPE /AWS1/ECSSTRING /AWS1/ECSSTRING¶
The short name of the capacity provider.
Optional arguments:¶
iv_weight TYPE /AWS1/ECSCAPPVDRSTRAGITEMWT /AWS1/ECSCAPPVDRSTRAGITEMWT¶
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The
weightvalue is taken into consideration after thebasevalue, if defined, is satisfied.If no
weightvalue is specified, the default value of0is 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 of0can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0, anyRunTaskorCreateServiceactions using the capacity provider strategy will fail.Weight value characteristics:
Weight is considered after the base value is satisfied
The default value is
0if not specifiedThe valid range is 0 to 1,000
At least one capacity provider must have a weight greater than zero
Capacity providers with weight of
0cannot place tasksTask distribution logic:
Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider
Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios
Examples:
Equal Distribution: Two capacity providers both with weight
1will split tasks evenly after base requirements are met.Weighted Distribution: If capacityProviderA has weight
1and capacityProviderB has weight4, then for every 1 task on A, 4 tasks will run on B.
iv_base TYPE /AWS1/ECSCAPPVDRSTRAGITEMBASE /AWS1/ECSCAPPVDRSTRAGITEMBASE¶
The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0is used.Base value characteristics:
Only one capacity provider in a strategy can have a base defined
The default value is
0if not specifiedThe valid range is 0 to 100,000
Base requirements are satisfied first before weight distribution
Queryable Attributes¶
capacityProvider¶
The short name of the capacity provider.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPACITYPROVIDER() |
Getter for CAPACITYPROVIDER, with configurable default |
ASK_CAPACITYPROVIDER() |
Getter for CAPACITYPROVIDER w/ exceptions if field has no va |
HAS_CAPACITYPROVIDER() |
Determine if CAPACITYPROVIDER has a value |
weight¶
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The
weightvalue is taken into consideration after thebasevalue, if defined, is satisfied.If no
weightvalue is specified, the default value of0is 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 of0can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0, anyRunTaskorCreateServiceactions using the capacity provider strategy will fail.Weight value characteristics:
Weight is considered after the base value is satisfied
The default value is
0if not specifiedThe valid range is 0 to 1,000
At least one capacity provider must have a weight greater than zero
Capacity providers with weight of
0cannot place tasksTask distribution logic:
Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider
Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios
Examples:
Equal Distribution: Two capacity providers both with weight
1will split tasks evenly after base requirements are met.Weighted Distribution: If capacityProviderA has weight
1and capacityProviderB has weight4, then for every 1 task on A, 4 tasks will run on B.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WEIGHT() |
Getter for WEIGHT |
base¶
The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0is used.Base value characteristics:
Only one capacity provider in a strategy can have a base defined
The default value is
0if not specifiedThe valid range is 0 to 100,000
Base requirements are satisfied first before weight distribution
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BASE() |
Getter for BASE |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_CAPACITYPROVIDERSTRATEGY¶
TYPES TT_CAPACITYPROVIDERSTRATEGY TYPE STANDARD TABLE OF REF TO /AWS1/CL_ECSCAPPVDRSTRAGITEM WITH DEFAULT KEY
.