com.amazonaws.services.gamelift.model

Class GameServerGroupAutoScalingPolicy

java.lang.Object

com.amazonaws.services.gamelift.model.GameServerGroupAutoScalingPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameServerGroupAutoScalingPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo

This data type is used with the GameLift FleetIQ and game server groups.

Configuration settings for intelligent automatic scaling that uses target tracking. These settings are used to add an Auto Scaling policy when creating the corresponding Auto Scaling group with CreateGameServerGroup. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GameServerGroupAutoScalingPolicy()

Method Summary

Modifier and Type	Method and Description
GameServerGroupAutoScalingPolicy	clone()
boolean	equals(Object obj)
Integer	getEstimatedInstanceWarmup() Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.
TargetTrackingConfiguration	getTargetTrackingConfiguration() Settings for a target-based scaling policy applied to Auto Scaling group.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup) Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.
void	setTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration) Settings for a target-based scaling policy applied to Auto Scaling group.
String	toString() Returns a string representation of this object.
GameServerGroupAutoScalingPolicy	withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup) Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.
GameServerGroupAutoScalingPolicy	withTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration) Settings for a target-based scaling policy applied to Auto Scaling group.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GameServerGroupAutoScalingPolicy

public GameServerGroupAutoScalingPolicy()

Method Detail

setEstimatedInstanceWarmup

public void setEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

Parameters:

estimatedInstanceWarmup - Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

getEstimatedInstanceWarmup

public Integer getEstimatedInstanceWarmup()

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

Returns:

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

withEstimatedInstanceWarmup

public GameServerGroupAutoScalingPolicy withEstimatedInstanceWarmup(Integer estimatedInstanceWarmup)

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

Parameters:

estimatedInstanceWarmup - Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

Returns:

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

setTargetTrackingConfiguration

public void setTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)

Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

Parameters:

targetTrackingConfiguration - Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

getTargetTrackingConfiguration

public TargetTrackingConfiguration getTargetTrackingConfiguration()

Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

Returns:

Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

withTargetTrackingConfiguration

public GameServerGroupAutoScalingPolicy withTargetTrackingConfiguration(TargetTrackingConfiguration targetTrackingConfiguration)

Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

Parameters:

targetTrackingConfiguration - Settings for a target-based scaling policy applied to Auto Scaling group. These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric "PercentUtilizedGameServers" and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 GameServerGroupAutoScalingPolicy clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.