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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass PutClusterCapacityProvidersRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_providersArray<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>)


6900
6901
6902
6903
6904
6905
6906
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6900

class PutClusterCapacityProvidersRequest < Struct.new(
  :cluster,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#clusterString

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)


6900
6901
6902
6903
6904
6905
6906
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6900

class PutClusterCapacityProvidersRequest < Struct.new(
  :cluster,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#default_capacity_provider_strategyArray<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.



6900
6901
6902
6903
6904
6905
6906
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6900

class PutClusterCapacityProvidersRequest < Struct.new(
  :cluster,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end