put_cluster_capacity_providers¶
Operation¶
put_cluster_capacity_providers
async
¶
put_cluster_capacity_providers(request: PutClusterCapacityProvidersInput | PutClusterCapacityProvidersInputDict, /, *, plugins: list[Plugin] | None = None) -> PutClusterCapacityProvidersOutput
put_cluster_capacity_providers(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[PutClusterCapacityProvidersInputDict]) -> PutClusterCapacityProvidersOutput
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity
provider or launch type is specified, then the cluster's default
capacity provider strategy is used. We recommend that you define a
default capacity provider strategy for your cluster. However, you must
specify an empty array ([]) to bypass defining a default strategy.
Amazon ECS Managed Instances doesn't support this, because when you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutClusterCapacityProvidersOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
PutClusterCapacityProvidersInput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutClusterCapacityProvidersInput structure.
Attributes¶
capacity_providers
class-attribute
instance-attribute
¶
The name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider 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.
cluster
class-attribute
instance-attribute
¶
cluster: str | None = ...
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.
default_capacity_provider_strategy
class-attribute
instance-attribute
¶
default_capacity_provider_strategy: list[CapacityProviderStrategyItem] | None = ...
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers
along with the base and weight to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The
PutClusterCapacityProviders
API is used to associate a capacity provider with a cluster. Only
capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider 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.
Dictionaries¶
PutClusterCapacityProvidersInputDict
¶
Bases: TypedDict
Dictionary form of PutClusterCapacityProvidersInput.
Attributes¶
capacity_providers
instance-attribute
¶
The name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider 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.
cluster
instance-attribute
¶
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don't specify a cluster, the default cluster is assumed.
default_capacity_provider_strategy
instance-attribute
¶
default_capacity_provider_strategy: Required[Sequence[CapacityProviderStrategyItem | CapacityProviderStrategyItemDict]]
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers
along with the base and weight to assign to them. A capacity
provider must be associated with the cluster to be used in a capacity
provider strategy. The
PutClusterCapacityProviders
API is used to associate a capacity provider with a cluster. Only
capacity providers with an ACTIVE or UPDATING status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider 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.
Output¶
PutClusterCapacityProvidersOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PutClusterCapacityProvidersOutput structure.
Attributes¶
cluster
class-attribute
instance-attribute
¶
cluster: Cluster | None = ...
Details about the cluster.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.