Package software.amazon.awscdk.services.ecs

Class CfnTaskSet.CapacityProviderStrategyItemProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.CfnTaskSet.CapacityProviderStrategyItemProperty.Jsii$Proxy

All Implemented Interfaces:

CfnTaskSet.CapacityProviderStrategyItemProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnTaskSet.CapacityProviderStrategyItemProperty

@Stability(Stable)
@Internal
public static final class CfnTaskSet.CapacityProviderStrategyItemProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnTaskSet.CapacityProviderStrategyItemProperty

An implementation for CfnTaskSet.CapacityProviderStrategyItemProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.CfnTaskSet.CapacityProviderStrategyItemProperty

CfnTaskSet.CapacityProviderStrategyItemProperty.Builder, CfnTaskSet.CapacityProviderStrategyItemProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnTaskSet.CapacityProviderStrategyItemProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnTaskSet.CapacityProviderStrategyItemProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Number	getBase()	The base value designates how many tasks, at a minimum, to run on the specified capacity provider for each service.
final String	getCapacityProvider()	The short name of the capacity provider.
final Number	getWeight()	The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnTaskSet.CapacityProviderStrategyItemProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnTaskSet.CapacityProviderStrategyItemProperty.Builder.

Method Details

getBase

public final Number getBase()

Description copied from interface: CfnTaskSet.CapacityProviderStrategyItemProperty

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

Specified by:

getBase in interface CfnTaskSet.CapacityProviderStrategyItemProperty

See Also:

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

getCapacityProvider

public final String getCapacityProvider()

Description copied from interface: CfnTaskSet.CapacityProviderStrategyItemProperty

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.

Specified by:

getCapacityProvider in interface CfnTaskSet.CapacityProviderStrategyItemProperty

See Also:

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

getWeight

public final Number getWeight()

Description copied from interface: CfnTaskSet.CapacityProviderStrategyItemProperty

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.

Specified by:

getWeight in interface CfnTaskSet.CapacityProviderStrategyItemProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object