@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
PlacementStrategy.Builder |
Modifier and Type | Method and Description |
---|---|
static PlacementStrategy.Builder |
builder() |
boolean |
equals(Object obj) |
String |
field()
The field to apply the placement strategy against.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
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() |
PlacementStrategyType |
type()
The type of placement strategy.
|
String |
typeString()
The type of placement strategy.
|
copy
public PlacementStrategyType 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).
If the service returns an enum value that is not available in the current SDK version, type
will return
PlacementStrategyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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).PlacementStrategyType
public String typeString()
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).
If the service returns an enum value that is not available in the current SDK version, type
will return
PlacementStrategyType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
typeString()
.
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).PlacementStrategyType
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.
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.public PlacementStrategy.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<PlacementStrategy.Builder,PlacementStrategy>
public static PlacementStrategy.Builder builder()
public static Class<? extends PlacementStrategy.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.