Put Cluster Capacity Providers
ecs_put_cluster_capacity_providers | R Documentation |
Modifies the available capacity providers and the default capacity provider strategy for a cluster¶
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 that are associated with a cluster that
are omitted from a put_cluster_capacity_providers
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.
Usage¶
Arguments¶
cluster
[required] 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.
capacityProviders
[required] 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
create_capacity_provider
API operation.To use a Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.defaultCapacityProviderStrategy
[required] 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
andweight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. Theput_cluster_capacity_providers
API is used to associate a capacity provider with a cluster. Only capacity providers with anACTIVE
orUPDATING
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
create_capacity_provider
API operation.To use a Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
Value¶
A list with the following syntax:
list(
cluster = list(
clusterArn = "string",
clusterName = "string",
configuration = list(
executeCommandConfiguration = list(
kmsKeyId = "string",
logging = "NONE"|"DEFAULT"|"OVERRIDE",
logConfiguration = list(
cloudWatchLogGroupName = "string",
cloudWatchEncryptionEnabled = TRUE|FALSE,
s3BucketName = "string",
s3EncryptionEnabled = TRUE|FALSE,
s3KeyPrefix = "string"
)
),
managedStorageConfiguration = list(
kmsKeyId = "string",
fargateEphemeralStorageKmsKeyId = "string"
)
),
status = "string",
registeredContainerInstancesCount = 123,
runningTasksCount = 123,
pendingTasksCount = 123,
activeServicesCount = 123,
statistics = list(
list(
name = "string",
value = "string"
)
),
tags = list(
list(
key = "string",
value = "string"
)
),
settings = list(
list(
name = "containerInsights",
value = "string"
)
),
capacityProviders = list(
"string"
),
defaultCapacityProviderStrategy = list(
list(
capacityProvider = "string",
weight = 123,
base = 123
)
),
attachments = list(
list(
id = "string",
type = "string",
status = "string",
details = list(
list(
name = "string",
value = "string"
)
)
)
),
attachmentsStatus = "string",
serviceConnectDefaults = list(
namespace = "string"
)
)
)