Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

PutClusterCapacityProvidersCommand

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ECSClient, PutClusterCapacityProvidersCommand } from "@aws-sdk/client-ecs"; // ES Modules import
// const { ECSClient, PutClusterCapacityProvidersCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
const client = new ECSClient(config);
const input = { // PutClusterCapacityProvidersRequest
  cluster: "STRING_VALUE", // required
  capacityProviders: [ // StringList // required
    "STRING_VALUE",
  ],
  defaultCapacityProviderStrategy: [ // CapacityProviderStrategy // required
    { // CapacityProviderStrategyItem
      capacityProvider: "STRING_VALUE", // required
      weight: Number("int"),
      base: Number("int"),
    },
  ],
};
const command = new PutClusterCapacityProvidersCommand(input);
const response = await client.send(command);
// { // PutClusterCapacityProvidersResponse
//   cluster: { // Cluster
//     clusterArn: "STRING_VALUE",
//     clusterName: "STRING_VALUE",
//     configuration: { // ClusterConfiguration
//       executeCommandConfiguration: { // ExecuteCommandConfiguration
//         kmsKeyId: "STRING_VALUE",
//         logging: "NONE" || "DEFAULT" || "OVERRIDE",
//         logConfiguration: { // ExecuteCommandLogConfiguration
//           cloudWatchLogGroupName: "STRING_VALUE",
//           cloudWatchEncryptionEnabled: true || false,
//           s3BucketName: "STRING_VALUE",
//           s3EncryptionEnabled: true || false,
//           s3KeyPrefix: "STRING_VALUE",
//         },
//       },
//       managedStorageConfiguration: { // ManagedStorageConfiguration
//         kmsKeyId: "STRING_VALUE",
//         fargateEphemeralStorageKmsKeyId: "STRING_VALUE",
//       },
//     },
//     status: "STRING_VALUE",
//     registeredContainerInstancesCount: Number("int"),
//     runningTasksCount: Number("int"),
//     pendingTasksCount: Number("int"),
//     activeServicesCount: Number("int"),
//     statistics: [ // Statistics
//       { // KeyValuePair
//         name: "STRING_VALUE",
//         value: "STRING_VALUE",
//       },
//     ],
//     tags: [ // Tags
//       { // Tag
//         key: "STRING_VALUE",
//         value: "STRING_VALUE",
//       },
//     ],
//     settings: [ // ClusterSettings
//       { // ClusterSetting
//         name: "containerInsights",
//         value: "STRING_VALUE",
//       },
//     ],
//     capacityProviders: [ // StringList
//       "STRING_VALUE",
//     ],
//     defaultCapacityProviderStrategy: [ // CapacityProviderStrategy
//       { // CapacityProviderStrategyItem
//         capacityProvider: "STRING_VALUE", // required
//         weight: Number("int"),
//         base: Number("int"),
//       },
//     ],
//     attachments: [ // Attachments
//       { // Attachment
//         id: "STRING_VALUE",
//         type: "STRING_VALUE",
//         status: "STRING_VALUE",
//         details: [ // AttachmentDetails
//           {
//             name: "STRING_VALUE",
//             value: "STRING_VALUE",
//           },
//         ],
//       },
//     ],
//     attachmentsStatus: "STRING_VALUE",
//     serviceConnectDefaults: { // ClusterServiceConnectDefaults
//       namespace: "STRING_VALUE",
//     },
//   },
// };

Example Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// This example adds an existing capacity provider "MyCapacityProvider2" to a cluster that already has the 
    capacity provider "MyCapacityProvider1" associated with it. Both "MyCapacityProvider2" and 
    "MyCapacityProvider1" need to be specified.
const input = {
  "capacityProviders": [
    "MyCapacityProvider1",
    "MyCapacityProvider2"
  ],
  "cluster": "MyCluster",
  "defaultCapacityProviderStrategy": [
    {
      "capacityProvider": "MyCapacityProvider1",
      "weight": 1
    },
    {
      "capacityProvider": "MyCapacityProvider2",
      "weight": 1
    }
  ]
};
const command = new PutClusterCapacityProvidersCommand(input);
const response = await client.send(command);
/* response ==
{
  "cluster": {
    "activeServicesCount": 0,
    "attachments": [
      {
        "type": "as_policy",
        "details": [
          {
            "name": "capacityProviderName",
            "value": "MyCapacityProvider1"
          },
          {
            "name": "scalingPolicyName",
            "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
          }
        ],
        "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
        "status": "ACTIVE"
      },
      {
        "type": "as_policy",
        "details": [
          {
            "name": "capacityProviderName",
            "value": "MyCapacityProvider2"
          },
          {
            "name": "scalingPolicyName",
            "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
          }
        ],
        "id": "ae592060-2382-4663-9476-b015c685593c",
        "status": "ACTIVE"
      }
    ],
    "attachmentsStatus": "UPDATE_IN_PROGRESS",
    "capacityProviders": [
      "MyCapacityProvider1",
      "MyCapacityProvider2"
    ],
    "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
    "clusterName": "MyCluster",
    "defaultCapacityProviderStrategy": [
      {
        "base": 0,
        "capacityProvider": "MyCapacityProvider1",
        "weight": 1
      },
      {
        "base": 0,
        "capacityProvider": "MyCapacityProvider2",
        "weight": 1
      }
    ],
    "pendingTasksCount": 0,
    "registeredContainerInstancesCount": 0,
    "runningTasksCount": 0,
    "settings": [
      {
        "name": "containerInsights",
        "value": "enabled"
      }
    ],
    "statistics": [],
    "status": "ACTIVE",
    "tags": []
  }
}
*\/
// example id: to-add-an-existing-capacity-provider-to-a-cluster-1734385195698
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

JavaScriptLn 1, Col 1

Errors: 0 Warnings: 0