Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PlacementStrategyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PlacementStrategyProperty.Jsii$Proxy

Enclosing class:

CfnPipe

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

The task placement strategy for a task or service.

To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.

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.*;
 PlacementStrategyProperty placementStrategyProperty = PlacementStrategyProperty.builder()
         .field("field")
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PlacementStrategyProperty.Builder	builder()
default String	getField()	The field to apply the placement strategy against.
default String	getType()	The type of placement strategy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getField

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

The field to apply the placement strategy against.

For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

getType

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

The type of placement strategy.

The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

builder

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

Returns:

a CfnPipe.PlacementStrategyProperty.Builder of CfnPipe.PlacementStrategyProperty