Class CapacityProviderStrategyItem

java.lang.Object
software.amazon.awssdk.services.ecs.model.CapacityProviderStrategyItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CapacityProviderStrategyItem.Builder,CapacityProviderStrategyItem>
@Generated("software.amazon.awssdk:codegen") public final class CapacityProviderStrategyItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CapacityProviderStrategyItem.Builder,CapacityProviderStrategyItem>

The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTaskor CreateCluster 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 CreateClusterCapacityProvider API operation.

To use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The 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.

With FARGATE_SPOT, you can run interruption tolerant tasks at a rate that's discounted compared to the FARGATE price. FARGATE_SPOT runs tasks on spare compute capacity. When Amazon Web Services needs the capacity back, your tasks are interrupted with a two-minute warning. FARGATE_SPOT supports Linux tasks with the X86_64 architecture on platform version 1.3.0 or later. FARGATE_SPOT supports Linux tasks with the ARM64 architecture on platform version 1.4.0 or later.

A capacity provider strategy can contain a maximum of 20 capacity providers.

See Also:

  • Method Details

    • capacityProvider

      public final String capacityProvider()

      The short name of the capacity provider.

      Returns:
      The short name of the capacity provider.

    • weight

      public final Integer 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

      • Default value is 0 if not specified

      • Valid range: 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:

      1. Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider

      2. 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:
      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

      • Default value is 0 if not specified

      • Valid range: 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:

      1. Base satisfaction: The minimum number of tasks specified by the base value are placed on that capacity provider

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

    • base

      public final Integer 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

      • Default value is 0 if not specified

      • Valid range: 0 to 100,000

      • Base requirements are satisfied first before weight distribution

      Returns:
      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

      • Default value is 0 if not specified

      • Valid range: 0 to 100,000

      • Base requirements are satisfied first before weight distribution

    • toBuilder

      public CapacityProviderStrategyItem.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CapacityProviderStrategyItem.Builder,CapacityProviderStrategyItem>
      Returns:
      a builder for type T

    • builder

      public static CapacityProviderStrategyItem.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CapacityProviderStrategyItem.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.