Class: AWSCDK::ECS::CfnClusterCapacityProviderAssociations::CapacityProviderStrategyProperty

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

Overview

The CapacityProviderStrategy property specifies the details of the default capacity provider strategy for the cluster.

When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CapacityProviderStrategyProperty.

Parameters:

  • capacity_provider (String) —

    The short name of the capacity provider.

  • 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.

  • 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.



522
523
524
525
526
527
528
529
 
# File 'ecs/cfn_cluster_capacity_provider_associations.rb', line 522

def initialize(capacity_provider:, base: nil, weight: nil)
  @capacity_provider = capacity_provider
  Jsii::Type.check_type(@capacity_provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "capacityProvider")
  @base = base
  Jsii::Type.check_type(@base, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "base") unless @base.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:



551
552
553
 
# File 'ecs/cfn_cluster_capacity_provider_associations.rb', line 551

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)

See Also:



537
538
539
 
# File 'ecs/cfn_cluster_capacity_provider_associations.rb', line 537

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:



579
580
581
 
# File 'ecs/cfn_cluster_capacity_provider_associations.rb', line 579

def weight
  @weight
end

Class Method Details

.jsii_properties ⇒ Object 



581
582
583
584
585
586
587
 
# File 'ecs/cfn_cluster_capacity_provider_associations.rb', line 581

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

Instance Method Details

#to_jsii ⇒ Object 



589
590
591
592
593
594
595
596
597
 
# File 'ecs/cfn_cluster_capacity_provider_associations.rb', line 589

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