Package software.amazon.awssdk.services.ecs.model

Class PlacementStrategy

java.lang.Object

software.amazon.awssdk.services.ecs.model.PlacementStrategy

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<PlacementStrategy.Builder,PlacementStrategy>

@Generated("software.amazon.awssdk:codegen")
public class PlacementStrategy
extends Object
implements StructuredPojo, ToCopyableBuilder<PlacementStrategy.Builder,PlacementStrategy>

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon EC2 Container Service Developer Guide.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PlacementStrategy.Builder

Method Summary

Modifier and Type	Method	Description
static PlacementStrategy.Builder	builder()
boolean	equals(Object obj)
String	field()	The field to apply the placement strategy against.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends PlacementStrategy.Builder>	serializableBuilderClass()
PlacementStrategy.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	type()	The type of placement strategy.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

type

public String type()

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).

Returns:

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).

See Also:

PlacementStrategyType

field

public String field()

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.

Returns:

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.

toBuilder

public PlacementStrategy.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PlacementStrategy.Builder,PlacementStrategy>

Returns:

a builder for type T

builder

public static PlacementStrategy.Builder builder()

serializableBuilderClass

public static Class<? extends PlacementStrategy.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.