Package software.amazon.awscdk.services.pipes

Interface CfnPipe.CapacityProviderStrategyItemProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.CapacityProviderStrategyItemProperty.Jsii$Proxy

Enclosing class:

CfnPipe

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

The details of a capacity provider strategy.

To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

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.pipes.*;
 CapacityProviderStrategyItemProperty capacityProviderStrategyItemProperty = CapacityProviderStrategyItemProperty.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	CfnPipe.CapacityProviderStrategyItemProperty.Builder	A builder for CfnPipe.CapacityProviderStrategyItemProperty
static final class	CfnPipe.CapacityProviderStrategyItemProperty.Jsii$Proxy	An implementation for CfnPipe.CapacityProviderStrategyItemProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.CapacityProviderStrategyItemProperty.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 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

getCapacityProvider

@Stability(Stable)
@NotNull
String getCapacityProvider()

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

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.

builder

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

Returns:

a CfnPipe.CapacityProviderStrategyItemProperty.Builder of CfnPipe.CapacityProviderStrategyItemProperty