You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ECS::Types::PutClusterCapacityProvidersRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutClusterCapacityProvidersRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  cluster: "String", # required
  capacity_providers: ["String"], # required
  default_capacity_provider_strategy: [ # required
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_providers ⇒ Array<String>

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 AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

Returns:

  • (Array<String>) —

    The name of one or more capacity providers to associate with the cluster.

#cluster ⇒ String

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.

Returns:

  • (String) —

    The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for.

#default_capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

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 AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

Returns: