Class: AWSCDK::ECS::CfnService::CapacityProviderStrategyItemProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/cfn_service.rb

Overview

The details of a capacity provider strategy.

A capacity provider strategy can be set when using the RunTask or CreateService APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.

Only capacity providers that are already associated with a cluster and have an ACTIVE or UPDATING status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use an 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 in a capacity provider strategy.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base: nil, capacity_provider: nil, weight: nil) ⇒ CapacityProviderStrategyItemProperty

Returns a new instance of CapacityProviderStrategyItemProperty.

Parameters:

  • base (Numeric, nil) (defaults to: nil) —

    The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.

  • capacity_provider (String, nil) (defaults to: nil) —

    The short name of the capacity provider.

  • weight (Numeric, nil) (defaults to: nil) —

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



1098
1099
1100
1101
1102
1103
1104
1105
 
# File 'ecs/cfn_service.rb', line 1098

def initialize(base: nil, capacity_provider: nil, weight: nil)
  @base = base
  Jsii::Type.check_type(@base, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "base") unless @base.nil?
  @capacity_provider = capacity_provider
  Jsii::Type.check_type(@capacity_provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityProvider") unless @capacity_provider.nil?
  @weight = weight
  Jsii::Type.check_type(@weight, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "weight") unless @weight.nil?
end

Instance Attribute Details

#base ⇒ Numeric? (readonly)

The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.

Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

Base value characteristics:

  • Only one capacity provider in a strategy can have a base defined
  • The default value is 0 if not specified
  • The valid range is 0 to 100,000
  • Base requirements are satisfied first before weight distribution

Returns:

  • (Numeric, nil)

See Also:



1120
1121
1122
 
# File 'ecs/cfn_service.rb', line 1120

def base
  @base
end

#capacity_provider ⇒ String? (readonly)

The short name of the capacity provider.

This can be either an AWS managed capacity provider ( FARGATE or FARGATE_SPOT ) or the name of a custom capacity provider that you created.

Returns:

  • (String, nil)

See Also:



1127
1128
1129
 
# File 'ecs/cfn_service.rb', line 1127

def capacity_provider
  @capacity_provider
end

#weight ⇒ Numeric? (readonly)

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

The weight value is taken into consideration after the base value, if defined, is satisfied.

If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0 , any RunTask or CreateService actions using the capacity provider strategy will fail.

Weight value characteristics:

  • Weight is considered after the base value is satisfied
  • The default value is 0 if not specified
  • The valid range is 0 to 1,000
  • At least one capacity provider must have a weight greater than zero
  • Capacity providers with weight of 0 cannot place tasks

Task distribution logic:

  • Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider
  • Weight distribution: After base requirements are met, additional tasks are distributed according to weight ratios

Examples:

Equal Distribution: Two capacity providers both with weight 1 will split tasks evenly after base requirements are met.

Weighted Distribution: If capacityProviderA has weight 1 and capacityProviderB has weight 4 , then for every 1 task on A, 4 tasks will run on B.

Returns:

  • (Numeric, nil)

See Also:



1155
1156
1157
 
# File 'ecs/cfn_service.rb', line 1155

def weight
  @weight
end

Class Method Details

.jsii_properties ⇒ Object 



1157
1158
1159
1160
1161
1162
1163
 
# File 'ecs/cfn_service.rb', line 1157

def self.jsii_properties
  {
    :base => "base",
    :capacity_provider => "capacityProvider",
    :weight => "weight",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'ecs/cfn_service.rb', line 1165

def to_jsii
  result = {}
  result.merge!({
    "base" => @base,
    "capacityProvider" => @capacity_provider,
    "weight" => @weight,
  })
  result.compact
end