Class ScalingPolicy
- java.lang.Object
-
- com.amazonaws.services.gamelift.model.ScalingPolicy
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class ScalingPolicy extends Object implements Serializable, Cloneable
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ScalingPolicy()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ScalingPolicy
clone()
boolean
equals(Object obj)
String
getComparisonOperator()
Comparison operator to use when measuring a 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 associated with this scaling policy.String
getMetricName()
Name of the GameLift-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.String
getStatus()
Current status of the scaling policy.Double
getThreshold()
Metric value used to trigger a scaling event.int
hashCode()
void
setComparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.void
setComparisonOperator(String comparisonOperator)
Comparison operator to use when measuring a 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 associated with this scaling policy.void
setMetricName(MetricName metricName)
Name of the GameLift-defined metric that is used to trigger an adjustment.void
setMetricName(String metricName)
Name of the GameLift-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
setStatus(ScalingStatusType status)
Current status of the scaling policy.void
setStatus(String status)
Current status of the scaling policy.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.ScalingPolicy
withComparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.ScalingPolicy
withComparisonOperator(String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.ScalingPolicy
withEvaluationPeriods(Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.ScalingPolicy
withFleetId(String fleetId)
Unique identity for the fleet associated with this scaling policy.ScalingPolicy
withMetricName(MetricName metricName)
Name of the GameLift-defined metric that is used to trigger an adjustment.ScalingPolicy
withMetricName(String metricName)
Name of the GameLift-defined metric that is used to trigger an adjustment.ScalingPolicy
withName(String name)
Descriptive label associated with this scaling policy.ScalingPolicy
withScalingAdjustment(Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.ScalingPolicy
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.ScalingPolicy
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.ScalingPolicy
withStatus(ScalingStatusType status)
Current status of the scaling policy.ScalingPolicy
withStatus(String status)
Current status of the scaling policy.ScalingPolicy
withThreshold(Double threshold)
Metric value used to trigger a scaling event.
-
-
-
Method Detail
-
setFleetId
public void setFleetId(String fleetId)
Unique identity for the fleet associated with this scaling policy.
- Parameters:
fleetId
- Unique identity for the fleet associated with this scaling policy.
-
getFleetId
public String getFleetId()
Unique identity for the fleet associated with this scaling policy.
- Returns:
- Unique identity for the fleet associated with this scaling policy.
-
withFleetId
public ScalingPolicy withFleetId(String fleetId)
Unique identity for the fleet associated with this scaling policy.
- Parameters:
fleetId
- Unique identity for the fleet associated with this scaling policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
public void setName(String name)
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this scaling policy. Policy names do not need to be unique.
-
getName
public String getName()
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
- Returns:
- Descriptive label associated with this scaling policy. Policy names do not need to be unique.
-
withName
public ScalingPolicy withName(String name)
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
- Parameters:
name
- Descriptive label associated with this scaling policy. Policy names do not need to be unique.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
public void setStatus(String status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- Parameters:
status
- Current status of the scaling policy. The scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- See Also:
ScalingStatusType
-
getStatus
public String getStatus()
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- Returns:
- Current status of the scaling policy. The scaling policy is only
in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- See Also:
ScalingStatusType
-
withStatus
public ScalingPolicy withStatus(String status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- Parameters:
status
- Current status of the scaling policy. The scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ScalingStatusType
-
setStatus
public void setStatus(ScalingStatusType status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- Parameters:
status
- Current status of the scaling policy. The scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- See Also:
ScalingStatusType
-
withStatus
public ScalingPolicy withStatus(ScalingStatusType status)
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- Parameters:
status
- Current status of the scaling policy. The scaling policy is only in force when in an Active state.- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ScalingStatusType
-
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 ScalingPolicy 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.
- 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.
- 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.
- 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.
- See Also:
ScalingAdjustmentType
-
withScalingAdjustmentType
public ScalingPolicy 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.
- 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.
- 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.
- 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.
- See Also:
ScalingAdjustmentType
-
withScalingAdjustmentType
public ScalingPolicy 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.
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ScalingAdjustmentType
-
setComparisonOperator
public void setComparisonOperator(String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
- Parameters:
comparisonOperator
- Comparison operator to use when measuring a metric against the threshold value.- See Also:
ComparisonOperatorType
-
getComparisonOperator
public String getComparisonOperator()
Comparison operator to use when measuring a metric against the threshold value.
- Returns:
- Comparison operator to use when measuring a metric against the threshold value.
- See Also:
ComparisonOperatorType
-
withComparisonOperator
public ScalingPolicy withComparisonOperator(String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
- Parameters:
comparisonOperator
- Comparison operator to use when measuring a 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 a metric against the threshold value.
- Parameters:
comparisonOperator
- Comparison operator to use when measuring a metric against the threshold value.- See Also:
ComparisonOperatorType
-
withComparisonOperator
public ScalingPolicy withComparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
- Parameters:
comparisonOperator
- Comparison operator to use when measuring a metric against the threshold value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ComparisonOperatorType
-
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 ScalingPolicy 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.
-
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 ScalingPolicy 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 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.
- Parameters:
metricName
- Name of the 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.
- See Also:
MetricName
-
getMetricName
public String getMetricName()
Name of the 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.
- Returns:
- Name of the 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.
- See Also:
MetricName
-
withMetricName
public ScalingPolicy withMetricName(String metricName)
Name of the 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.
- Parameters:
metricName
- Name of the 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.
- 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 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.
- Parameters:
metricName
- Name of the 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.
- See Also:
MetricName
-
withMetricName
public ScalingPolicy withMetricName(MetricName metricName)
Name of the 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.
- Parameters:
metricName
- Name of the 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.
- 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public ScalingPolicy clone()
-
-