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

Class PutScalingPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.PutScalingPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutScalingPolicyRequest
extends GameLiftRequest
implements ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutScalingPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutScalingPolicyRequest.Builder	builder()
ComparisonOperatorType	comparisonOperator()	Comparison operator to use when measuring the metric against the threshold value.
String	comparisonOperatorAsString()	Comparison operator to use when measuring the metric against the threshold value.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	evaluationPeriods()	Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
String	fleetId()	A unique identifier for the fleet to apply this policy to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MetricName	metricName()	Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
String	metricNameAsString()	Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
String	name()	A descriptive label that is associated with a fleet's scaling policy.
PolicyType	policyType()	The type of scaling policy to create.
String	policyTypeAsString()	The type of scaling policy to create.
Integer	scalingAdjustment()	Amount of adjustment to make, based on the scaling adjustment type.
ScalingAdjustmentType	scalingAdjustmentType()	The type of adjustment to make to a fleet's instance count:
String	scalingAdjustmentTypeAsString()	The type of adjustment to make to a fleet's instance count:
List<SdkField<?>>	sdkFields()
static Class<? extends PutScalingPolicyRequest.Builder>	serializableBuilderClass()
TargetConfiguration	targetConfiguration()	An object that contains settings for a target-based scaling policy.
Double	threshold()	Metric value used to trigger a scaling event.
PutScalingPolicyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Returns:

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

fleetId

public final String fleetId()

A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Returns:

A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.

scalingAdjustment

public final Integer scalingAdjustment()

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

Returns:

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

scalingAdjustmentType

public final ScalingAdjustmentType scalingAdjustmentType()

The type of adjustment to make to a fleet's instance count:

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

If the service returns an enum value that is not available in the current SDK version, scalingAdjustmentType will return ScalingAdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingAdjustmentTypeAsString().

Returns:

The type of adjustment to make to a fleet's instance count:

• 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

scalingAdjustmentTypeAsString

public final String scalingAdjustmentTypeAsString()

The type of adjustment to make to a fleet's instance count:

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

If the service returns an enum value that is not available in the current SDK version, scalingAdjustmentType will return ScalingAdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingAdjustmentTypeAsString().

Returns:

The type of adjustment to make to a fleet's instance count:

• 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

threshold

public final Double threshold()

Metric value used to trigger a scaling event.

Returns:

Metric value used to trigger a scaling event.

comparisonOperator

public final ComparisonOperatorType comparisonOperator()

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

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

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

See Also:

ComparisonOperatorType

comparisonOperatorAsString

public final String comparisonOperatorAsString()

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

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

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

See Also:

ComparisonOperatorType

evaluationPeriods

public final Integer evaluationPeriods()

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.

metricName

public final MetricName metricName()

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

• ActivatingGameSessions -- Game sessions in the process of being created.

• ActiveGameSessions -- Game sessions that are currently running.

• ActiveInstances -- Fleet instances that are currently running at least one game session.

• AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

• AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

• CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

• IdleInstances -- Active instances that are currently hosting zero game sessions.

• PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

• PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

• QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

• WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

If the service returns an enum value that is not available in the current SDK version, metricName will return MetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

• ActivatingGameSessions -- Game sessions in the process of being created.

• ActiveGameSessions -- Game sessions that are currently running.

• ActiveInstances -- Fleet instances that are currently running at least one game session.

• AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

• AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

• CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

• IdleInstances -- Active instances that are currently hosting zero game sessions.

• PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

• PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

• QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

• WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

See Also:

MetricName

metricNameAsString

public final String metricNameAsString()

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

• ActivatingGameSessions -- Game sessions in the process of being created.

• ActiveGameSessions -- Game sessions that are currently running.

• ActiveInstances -- Fleet instances that are currently running at least one game session.

• AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

• AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

• CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

• IdleInstances -- Active instances that are currently hosting zero game sessions.

• PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

• PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

• QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

• WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

If the service returns an enum value that is not available in the current SDK version, metricName will return MetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

• ActivatingGameSessions -- Game sessions in the process of being created.

• ActiveGameSessions -- Game sessions that are currently running.

• ActiveInstances -- Fleet instances that are currently running at least one game session.

• AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

• AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

• CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

• IdleInstances -- Active instances that are currently hosting zero game sessions.

• PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

• PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

• QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

• WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

See Also:

MetricName

policyType

public final PolicyType policyType()

The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

See Also:

PolicyType

policyTypeAsString

public final String policyTypeAsString()

The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().

Returns:

The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

See Also:

PolicyType

targetConfiguration

public final TargetConfiguration targetConfiguration()

An object that contains settings for a target-based scaling policy.

Returns:

An object that contains settings for a target-based scaling policy.

toBuilder

public PutScalingPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static PutScalingPolicyRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo