Package software.amazon.awscdk.services.ecs

Interface CapacityProviderStrategy

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CapacityProviderStrategy.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:47.028Z")
@Stability(Stable)
public interface CapacityProviderStrategy
extends software.amazon.jsii.JsiiSerializable

A Capacity Provider strategy to use for the service.

NOTE: defaultCapacityProviderStrategy on cluster not currently supported.

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.*;
 CapacityProviderStrategy capacityProviderStrategy = CapacityProviderStrategy.builder()
         .capacityProvider("capacityProvider")
         // the properties below are optional
         .base(123)
         .weight(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CapacityProviderStrategy.Builder	builder()
default Number	getBase()	The base value designates how many tasks, at a minimum, to run on the specified capacity provider.
String	getCapacityProvider()	The 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

getCapacityProvider

@Stability(Stable)
@NotNull
String getCapacityProvider()

The name of the capacity provider.

getBase

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

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.

Default: - none

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.

Default: - 0

builder

@Stability(Stable)
static CapacityProviderStrategy.Builder builder()

Returns:

a CapacityProviderStrategy.Builder of CapacityProviderStrategy