StructuredPojo
, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
@Generated("software.amazon.awssdk:codegen") public class ScalingPolicy extends Object implements StructuredPojo, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
Modifier and Type | Class | Description |
---|---|---|
static interface |
ScalingPolicy.Builder |
Modifier and Type | Method | Description |
---|---|---|
static ScalingPolicy.Builder |
builder() |
|
String |
comparisonOperator() |
Comparison operator to use when measuring a metric against the threshold value.
|
boolean |
equals(Object obj) |
|
Integer |
evaluationPeriods() |
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
|
String |
fleetId() |
Unique identifier for a fleet that is associated with this scaling policy.
|
int |
hashCode() |
|
void |
marshall(ProtocolMarshaller protocolMarshaller) |
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
metricName() |
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
|
String |
name() |
Descriptive label that is associated with a scaling policy.
|
Integer |
scalingAdjustment() |
Amount of adjustment to make, based on the scaling adjustment type.
|
String |
scalingAdjustmentType() |
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
|
static Class<? extends ScalingPolicy.Builder> |
serializableBuilderClass() |
|
String |
status() |
Current status of the scaling policy.
|
Double |
threshold() |
Metric value used to trigger a scaling event.
|
ScalingPolicy.Builder |
toBuilder() |
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
public String fleetId()
Unique identifier for a fleet that is associated with this scaling policy.
public String name()
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
public String status()
Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE
status.
ACTIVE – The scaling policy is currently in force.
UPDATE_REQUESTED – A request to update the scaling policy has been received.
UPDATING – A change is being made to the scaling policy.
DELETE_REQUESTED – A request to delete the scaling policy has been received.
DELETING – The scaling policy is being deleted.
DELETED – The scaling policy has been deleted.
ERROR – An error occurred in creating the policy. It should be removed and recreated.
ACTIVE
status.
ACTIVE – The scaling policy is currently in force.
UPDATE_REQUESTED – A request to update the scaling policy has been received.
UPDATING – A change is being made to the scaling policy.
DELETE_REQUESTED – A request to delete the scaling policy has been received.
DELETING – The scaling policy is being deleted.
DELETED – The scaling policy has been deleted.
ERROR – An error occurred in creating the policy. It should be removed and recreated.
ScalingStatusType
public Integer scalingAdjustment()
Amount of adjustment to make, based on the scaling adjustment type.
public String scalingAdjustmentType()
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
ChangeInCapacity – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity – set the instance count to the scaling adjustment value.
PercentChangeInCapacity – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
ChangeInCapacity – add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
ExactCapacity – set the instance count to the scaling adjustment value.
PercentChangeInCapacity – increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
ScalingAdjustmentType
public String comparisonOperator()
Comparison operator to use when measuring a metric against the threshold value.
ComparisonOperatorType
public Double threshold()
Metric value used to trigger a scaling event.
public Integer evaluationPeriods()
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
public String metricName()
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions – number of game sessions in the process of being created (game session status =
ACTIVATING
).
ActiveGameSessions – number of game sessions currently running (game session status = ACTIVE
).
CurrentPlayerSessions – number of active or reserved player sessions (player session status =
ACTIVE
or RESERVED
).
AvailablePlayerSessions – number of player session slots currently available in active game sessions
across the fleet, calculated by subtracting a game session's current player session count from its maximum player
session count. This number does include game sessions that are not currently accepting players (game session
PlayerSessionCreationPolicy
= DENY_ALL
).
ActiveInstances – number of instances currently running a game session.
IdleInstances – number of instances not currently running a game session.
ActivatingGameSessions – number of game sessions in the process of being created (game session
status = ACTIVATING
).
ActiveGameSessions – number of game sessions currently running (game session status =
ACTIVE
).
CurrentPlayerSessions – number of active or reserved player sessions (player session status =
ACTIVE
or RESERVED
).
AvailablePlayerSessions – number of player session slots currently available in active game
sessions across the fleet, calculated by subtracting a game session's current player session count from
its maximum player session count. This number does include game sessions that are not currently accepting
players (game session PlayerSessionCreationPolicy
= DENY_ALL
).
ActiveInstances – number of instances currently running a game session.
IdleInstances – number of instances not currently running a game session.
MetricName
public ScalingPolicy.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
public static ScalingPolicy.Builder builder()
public static Class<? extends ScalingPolicy.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.