AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ECS::Types::CapacityProviderStrategyItem

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 CapacityProviderStrategyItem data as a hash:

{
  capacity_provider: "String", # required
  weight: 1,
  base: 1,
}

The details of a capacity provider strategy.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#baseInteger

The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.

Returns:

  • (Integer)


461
462
463
464
465
466
467
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 461

class CapacityProviderStrategyItem < Struct.new(
  :capacity_provider,
  :weight,
  :base)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_providerString

The short name of the capacity provider.

Returns:

  • (String)


461
462
463
464
465
466
467
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 461

class CapacityProviderStrategyItem < Struct.new(
  :capacity_provider,
  :weight,
  :base)
  SENSITIVE = []
  include Aws::Structure
end

#weightInteger

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

For example, if you have a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.

Returns:

  • (Integer)


461
462
463
464
465
466
467
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 461

class CapacityProviderStrategyItem < Struct.new(
  :capacity_provider,
  :weight,
  :base)
  SENSITIVE = []
  include Aws::Structure
end