Package software.amazon.awscdk.services.ecs

Class CfnTaskSet.CapacityProviderStrategyItemProperty.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.CfnTaskSet.CapacityProviderStrategyItemProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTaskSet.CapacityProviderStrategyItemProperty>
Enclosing interface:
CfnTaskSet.CapacityProviderStrategyItemProperty
@Stability(Stable) public static final class CfnTaskSet.CapacityProviderStrategyItemProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnTaskSet.CapacityProviderStrategyItemProperty>
A builder for CfnTaskSet.CapacityProviderStrategyItemProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • base

      @Stability(Stable) public CfnTaskSet.CapacityProviderStrategyItemProperty.Builder base(Number base)
      Sets the value of CfnTaskSet.CapacityProviderStrategyItemProperty.getBase()
      Parameters:
      base - 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:
      this

    • capacityProvider

      @Stability(Stable) public CfnTaskSet.CapacityProviderStrategyItemProperty.Builder capacityProvider(String capacityProvider)
      Sets the value of CfnTaskSet.CapacityProviderStrategyItemProperty.getCapacityProvider()
      Parameters:
      capacityProvider - 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:
      this

    • weight

      @Stability(Stable) public CfnTaskSet.CapacityProviderStrategyItemProperty.Builder weight(Number weight)
      Sets the value of CfnTaskSet.CapacityProviderStrategyItemProperty.getWeight()
      Parameters:
      weight - 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:
      this

    • build

      @Stability(Stable) public CfnTaskSet.CapacityProviderStrategyItemProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTaskSet.CapacityProviderStrategyItemProperty>
      Returns:
      a new instance of CfnTaskSet.CapacityProviderStrategyItemProperty
      Throws:
      NullPointerException - if any required attribute was not provided