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

Class GameServerGroupAutoScalingPolicy

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameServerGroupAutoScalingPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GameServerGroupAutoScalingPolicy.Builder,GameServerGroupAutoScalingPolicy>

@Generated("software.amazon.awssdk:codegen")
public final class GameServerGroupAutoScalingPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GameServerGroupAutoScalingPolicy.Builder,GameServerGroupAutoScalingPolicy>

This data type is used with the Amazon 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. 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GameServerGroupAutoScalingPolicy.Builder

Method Summary

Modifier and Type	Method	Description
static GameServerGroupAutoScalingPolicy.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	estimatedInstanceWarmup()	Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift FleetIQ.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GameServerGroupAutoScalingPolicy.Builder>	serializableBuilderClass()
TargetTrackingConfiguration	targetTrackingConfiguration()	Settings for a target-based scaling policy applied to Auto Scaling group.
GameServerGroupAutoScalingPolicy.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

estimatedInstanceWarmup

public final Integer estimatedInstanceWarmup()

Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon 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 Amazon 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.

targetTrackingConfiguration

public final 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 Amazon 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 Amazon 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.

toBuilder

public GameServerGroupAutoScalingPolicy.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameServerGroupAutoScalingPolicy.Builder,GameServerGroupAutoScalingPolicy>

builder

public static GameServerGroupAutoScalingPolicy.Builder builder()

serializableBuilderClass

public static Class<? extends GameServerGroupAutoScalingPolicy.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo