software.amazon.awssdk.services.gamelift.model

Class TargetConfiguration

java.lang.Object

software.amazon.awssdk.services.gamelift.model.TargetConfiguration

All Implemented Interfaces:

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

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

Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TargetConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static TargetConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends TargetConfiguration.Builder>	serializableBuilderClass()
Double	targetValue() Desired value to use with a target-based scaling policy.
TargetConfiguration.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

targetValue

public final Double targetValue()

Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

Returns:

Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

toBuilder

public TargetConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TargetConfiguration.Builder,TargetConfiguration>

builder

public static TargetConfiguration.Builder builder()

serializableBuilderClass

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