software.amazon.awscdk.services.ecs

Class CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty>

Enclosing interface:

CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty

@Stability(value=Stable)
public static final class CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty>

A builder for CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder	base(Number base) Sets the value of CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.getBase()
CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty	build() Builds the configured instance.
CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder	capacityProvider(String capacityProvider) Sets the value of CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.getCapacityProvider()
CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder	weight(Number weight) Sets the value of CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.getWeight()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

capacityProvider

@Stability(value=Stable)
public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder capacityProvider(String capacityProvider)

Sets the value of CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.getCapacityProvider()

Parameters:

capacityProvider - The short name of the capacity provider. This parameter is required.

Returns:

this

base

@Stability(value=Stable)
public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder base(Number base)

Sets the value of CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.getBase()

Parameters:

base - The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. 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.

Returns:

this

weight

@Stability(value=Stable)
public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.Builder weight(Number weight)

Sets the value of CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty.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 will not 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.

An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB , then for every one task that is run using capacityProviderA , four tasks would use capacityProviderB .

Returns:

this

build

@Stability(value=Stable)
public CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty>

Returns:

a new instance of CfnClusterCapacityProviderAssociations.CapacityProviderStrategyProperty

Throws:

NullPointerException - if any required attribute was not provided