com.amazonaws.services.gamelift.model

Class PutScalingPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.gamelift.model.PutScalingPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutScalingPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input for a request action.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutScalingPolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutScalingPolicyRequest	clone()
boolean	equals(Object obj)
String	getComparisonOperator() Comparison operator to use when measuring the metric against the threshold value.
Integer	getEvaluationPeriods() Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
String	getFleetId() Unique identity for the fleet to scale with this policy.
String	getMetricName() Name of the Service-defined metric that is used to trigger an adjustment.
String	getName() Descriptive label associated with this scaling policy.
Integer	getScalingAdjustment() Amount of adjustment to make, based on the scaling adjustment type.
String	getScalingAdjustmentType() 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.
Double	getThreshold() Metric value used to trigger a scaling event.
int	hashCode()
void	setComparisonOperator(ComparisonOperatorType comparisonOperator) Comparison operator to use when measuring the metric against the threshold value.
void	setComparisonOperator(String comparisonOperator) Comparison operator to use when measuring the metric against the threshold value.
void	setEvaluationPeriods(Integer evaluationPeriods) Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
void	setFleetId(String fleetId) Unique identity for the fleet to scale with this policy.
void	setMetricName(MetricName metricName) Name of the Service-defined metric that is used to trigger an adjustment.
void	setMetricName(String metricName) Name of the Service-defined metric that is used to trigger an adjustment.
void	setName(String name) Descriptive label associated with this scaling policy.
void	setScalingAdjustment(Integer scalingAdjustment) Amount of adjustment to make, based on the scaling adjustment type.
void	setScalingAdjustmentType(ScalingAdjustmentType 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.
void	setScalingAdjustmentType(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.
void	setThreshold(Double threshold) Metric value used to trigger a scaling event.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutScalingPolicyRequest	withComparisonOperator(ComparisonOperatorType comparisonOperator) Comparison operator to use when measuring the metric against the threshold value.
PutScalingPolicyRequest	withComparisonOperator(String comparisonOperator) Comparison operator to use when measuring the metric against the threshold value.
PutScalingPolicyRequest	withEvaluationPeriods(Integer evaluationPeriods) Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
PutScalingPolicyRequest	withFleetId(String fleetId) Unique identity for the fleet to scale with this policy.
PutScalingPolicyRequest	withMetricName(MetricName metricName) Name of the Service-defined metric that is used to trigger an adjustment.
PutScalingPolicyRequest	withMetricName(String metricName) Name of the Service-defined metric that is used to trigger an adjustment.
PutScalingPolicyRequest	withName(String name) Descriptive label associated with this scaling policy.
PutScalingPolicyRequest	withScalingAdjustment(Integer scalingAdjustment) Amount of adjustment to make, based on the scaling adjustment type.
PutScalingPolicyRequest	withScalingAdjustmentType(ScalingAdjustmentType 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.
PutScalingPolicyRequest	withScalingAdjustmentType(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.
PutScalingPolicyRequest	withThreshold(Double threshold) Metric value used to trigger a scaling event.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutScalingPolicyRequest

public PutScalingPolicyRequest()

Method Detail

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

Descriptive label associated with this 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 associated with this scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

withName

public PutScalingPolicyRequest withName(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setFleetId

public void setFleetId(String fleetId)

Unique identity for the fleet to scale with this policy.

Parameters:

fleetId - Unique identity for the fleet to scale with this policy.

getFleetId

public String getFleetId()

Unique identity for the fleet to scale with this policy.

Returns:

Unique identity for the fleet to scale with this policy.

withFleetId

public PutScalingPolicyRequest withFleetId(String fleetId)

Unique identity for the fleet to scale with this policy.

Parameters:

fleetId - Unique identity for the fleet to scale with this policy.

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalingAdjustment

public void setScalingAdjustment(Integer scalingAdjustment)

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

Parameters:

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

getScalingAdjustment

public Integer getScalingAdjustment()

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

Returns:

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

withScalingAdjustment

public PutScalingPolicyRequest withScalingAdjustment(Integer scalingAdjustment)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setScalingAdjustmentType

public void setScalingAdjustmentType(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%.

Parameters:

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

See Also:

ScalingAdjustmentType

getScalingAdjustmentType

public String getScalingAdjustmentType()

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

withScalingAdjustmentType

public PutScalingPolicyRequest withScalingAdjustmentType(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%.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingAdjustmentType

setScalingAdjustmentType

public void setScalingAdjustmentType(ScalingAdjustmentType 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%.

Parameters:

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

See Also:

ScalingAdjustmentType

withScalingAdjustmentType

public PutScalingPolicyRequest withScalingAdjustmentType(ScalingAdjustmentType 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%.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingAdjustmentType

setThreshold

public void setThreshold(Double threshold)

Metric value used to trigger a scaling event.

Parameters:

threshold - Metric value used to trigger a scaling event.

getThreshold

public Double getThreshold()

Metric value used to trigger a scaling event.

Returns:

Metric value used to trigger a scaling event.

withThreshold

public PutScalingPolicyRequest withThreshold(Double threshold)

Metric value used to trigger a scaling event.

Parameters:

threshold - Metric value used to trigger a scaling event.

Returns:

Returns a reference to this object so that method calls can be chained together.

setComparisonOperator

public void setComparisonOperator(String comparisonOperator)

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

Parameters:

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

See Also:

ComparisonOperatorType

getComparisonOperator

public String getComparisonOperator()

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

withComparisonOperator

public PutScalingPolicyRequest withComparisonOperator(String comparisonOperator)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComparisonOperatorType

setComparisonOperator

public void setComparisonOperator(ComparisonOperatorType comparisonOperator)

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

Parameters:

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

See Also:

ComparisonOperatorType

withComparisonOperator

public PutScalingPolicyRequest withComparisonOperator(ComparisonOperatorType comparisonOperator)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComparisonOperatorType

setEvaluationPeriods

public void setEvaluationPeriods(Integer evaluationPeriods)

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

Parameters:

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

getEvaluationPeriods

public Integer getEvaluationPeriods()

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.

withEvaluationPeriods

public PutScalingPolicyRequest withEvaluationPeriods(Integer evaluationPeriods)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMetricName

public void setMetricName(String metricName)

Name of the Service-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.

Parameters:

metricName - Name of the Service-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

getMetricName

public String getMetricName()

Name of the Service-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 Service-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

withMetricName

public PutScalingPolicyRequest withMetricName(String metricName)

Name of the Service-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.

Parameters:

metricName - Name of the Service-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:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricName

setMetricName

public void setMetricName(MetricName metricName)

Name of the Service-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.

Parameters:

metricName - Name of the Service-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

withMetricName

public PutScalingPolicyRequest withMetricName(MetricName metricName)

Name of the Service-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.

Parameters:

metricName - Name of the Service-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:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricName

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutScalingPolicyRequest clone()

Overrides:

clone in class AmazonWebServiceRequest