Package software.amazon.awscdk.services.ecs

Interface CfnCluster.CapacityProviderStrategyItemProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCluster.CapacityProviderStrategyItemProperty.Jsii$Proxy

Enclosing class:

CfnCluster

@Stability(Stable)
public static interface CfnCluster.CapacityProviderStrategyItemProperty
extends software.amazon.jsii.JsiiSerializable

The CapacityProviderStrategyItem 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 CapacityProviderStrategyItemProperty capacityProviderStrategyItemProperty = CapacityProviderStrategyItemProperty.builder()
         .base(123)
         .capacityProvider("capacityProvider")
         .weight(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCluster.CapacityProviderStrategyItemProperty.Builder	A builder for CfnCluster.CapacityProviderStrategyItemProperty
static final class	CfnCluster.CapacityProviderStrategyItemProperty.Jsii$Proxy	An implementation for CfnCluster.CapacityProviderStrategyItemProperty

Method Summary

Modifier and Type	Method	Description
static CfnCluster.CapacityProviderStrategyItemProperty.Builder	builder()
default Number	getBase()	The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.
default String	getCapacityProvider()	The short name of the capacity provider.
default Number	getWeight()	The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBase

@Stability(Stable)
@Nullable
default Number getBase()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-base

getCapacityProvider

@Stability(Stable)
@Nullable
default String getCapacityProvider()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-capacityprovider

getWeight

@Stability(Stable)
@Nullable
default Number getWeight()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-capacityproviderstrategyitem.html#cfn-ecs-cluster-capacityproviderstrategyitem-weight

builder

@Stability(Stable)
static CfnCluster.CapacityProviderStrategyItemProperty.Builder builder()

Returns:

a CfnCluster.CapacityProviderStrategyItemProperty.Builder of CfnCluster.CapacityProviderStrategyItemProperty