| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.ECS.PutClusterCapacityProviders
Description
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 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. It is recommended to define a
default capacity provider strategy for your cluster, however you may
specify an empty array ([]) to bypass defining a default strategy.
Synopsis
- data PutClusterCapacityProviders = PutClusterCapacityProviders' {}
- newPutClusterCapacityProviders :: Text -> PutClusterCapacityProviders
- putClusterCapacityProviders_cluster :: Lens' PutClusterCapacityProviders Text
- putClusterCapacityProviders_capacityProviders :: Lens' PutClusterCapacityProviders [Text]
- putClusterCapacityProviders_defaultCapacityProviderStrategy :: Lens' PutClusterCapacityProviders [CapacityProviderStrategyItem]
- data PutClusterCapacityProvidersResponse = PutClusterCapacityProvidersResponse' {
- cluster :: Maybe Cluster
- httpStatus :: Int
- newPutClusterCapacityProvidersResponse :: Int -> PutClusterCapacityProvidersResponse
- putClusterCapacityProvidersResponse_cluster :: Lens' PutClusterCapacityProvidersResponse (Maybe Cluster)
- putClusterCapacityProvidersResponse_httpStatus :: Lens' PutClusterCapacityProvidersResponse Int
Creating a Request
data PutClusterCapacityProviders Source #
See: newPutClusterCapacityProviders smart constructor.
Constructors
| PutClusterCapacityProviders' | |
Fields
| |
Instances
newPutClusterCapacityProviders Source #
Create a value of PutClusterCapacityProviders with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cluster:PutClusterCapacityProviders', putClusterCapacityProviders_cluster - The short name or full Amazon Resource Name (ARN) of the cluster to
modify the capacity provider settings for. If you do not specify a
cluster, the default cluster is assumed.
$sel:capacityProviders:PutClusterCapacityProviders', putClusterCapacityProviders_capacityProviders - 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.
$sel:defaultCapacityProviderStrategy:PutClusterCapacityProviders', putClusterCapacityProviders_defaultCapacityProviderStrategy - 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.
Request Lenses
putClusterCapacityProviders_cluster :: Lens' PutClusterCapacityProviders Text Source #
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.
putClusterCapacityProviders_capacityProviders :: Lens' PutClusterCapacityProviders [Text] Source #
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.
putClusterCapacityProviders_defaultCapacityProviderStrategy :: Lens' PutClusterCapacityProviders [CapacityProviderStrategyItem] Source #
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.
Destructuring the Response
data PutClusterCapacityProvidersResponse Source #
See: newPutClusterCapacityProvidersResponse smart constructor.
Constructors
| PutClusterCapacityProvidersResponse' | |
Fields
| |
Instances
newPutClusterCapacityProvidersResponse Source #
Arguments
| :: Int | |
| -> PutClusterCapacityProvidersResponse |
Create a value of PutClusterCapacityProvidersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cluster:PutClusterCapacityProviders', putClusterCapacityProvidersResponse_cluster - Details about the cluster.
$sel:httpStatus:PutClusterCapacityProvidersResponse', putClusterCapacityProvidersResponse_httpStatus - The response's http status code.
Response Lenses
putClusterCapacityProvidersResponse_cluster :: Lens' PutClusterCapacityProvidersResponse (Maybe Cluster) Source #
Details about the cluster.
putClusterCapacityProvidersResponse_httpStatus :: Lens' PutClusterCapacityProvidersResponse Int Source #
The response's http status code.