Package software.amazon.awssdk.services.gamelift.model

Class PutScalingPolicyRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.gamelift.model.PutScalingPolicyRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

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

Represents the input for a request action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutScalingPolicyRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static PutScalingPolicyRequest.Builder	builder()
String	comparisonOperator()	Comparison operator to use when measuring the 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 to apply this policy to.
int	hashCode()
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 PutScalingPolicyRequest.Builder>	serializableBuilderClass()
Double	threshold()	Metric value used to trigger a scaling event.
PutScalingPolicyRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

public String name()

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Returns:

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

fleetId

public String fleetId()

Unique identifier for a fleet to apply this policy to.

Returns:

Unique identifier for a fleet to apply this policy to.

scalingAdjustment

public Integer scalingAdjustment()

Amount of adjustment to make, based on the scaling adjustment type.

Returns:

Amount of adjustment to make, based on the scaling adjustment type.

scalingAdjustmentType

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; for example, a value of "-10" scales the fleet down by 10%.

Returns:

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; for example, a value of "-10" scales the fleet down by 10%.

See Also:

ScalingAdjustmentType

threshold

public Double threshold()

Metric value used to trigger a scaling event.

Returns:

Metric value used to trigger a scaling event.

comparisonOperator

public String comparisonOperator()

Comparison operator to use when measuring the metric against the threshold value.

Returns:

Comparison operator to use when measuring the metric against the threshold value.

See Also:

ComparisonOperatorType

evaluationPeriods

public Integer evaluationPeriods()

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

Returns:

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

metricName

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

Returns:

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

See Also:

MetricName

toBuilder

public PutScalingPolicyRequest.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<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Returns:

a builder for type T

builder

public static PutScalingPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutScalingPolicyRequest.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