Package software.amazon.awscdk.services.gamelift

Class CfnFleet.ScalingPolicyProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.gamelift.CfnFleet.ScalingPolicyProperty.Jsii$Proxy

All Implemented Interfaces:

CfnFleet.ScalingPolicyProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnFleet.ScalingPolicyProperty

@Stability(Stable)
@Internal
public static final class CfnFleet.ScalingPolicyProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnFleet.ScalingPolicyProperty

An implementation for CfnFleet.ScalingPolicyProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.CfnFleet.ScalingPolicyProperty

CfnFleet.ScalingPolicyProperty.Builder, CfnFleet.ScalingPolicyProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnFleet.ScalingPolicyProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnFleet.ScalingPolicyProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getComparisonOperator()	Comparison operator to use when measuring a metric against the threshold value.
final Number	getEvaluationPeriods()	Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
final String	getLocation()	The fleet location.
final String	getMetricName()	Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
final String	getName()	A descriptive label that is associated with a fleet's scaling policy.
final String	getPolicyType()	The type of scaling policy to create.
final Number	getScalingAdjustment()	Amount of adjustment to make, based on the scaling adjustment type.
final String	getScalingAdjustmentType()	The type of adjustment to make to a fleet's instance count.
final String	getStatus()	Current status of the scaling policy.
final Object	getTargetConfiguration()	An object that contains settings for a target-based scaling policy.
final Number	getThreshold()	Metric value used to trigger a scaling event.
final String	getUpdateStatus()	The current status of the fleet's scaling policies in a requested fleet location.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnFleet.ScalingPolicyProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnFleet.ScalingPolicyProperty.Builder.

Method Details

getMetricName

public final String getMetricName()

Description copied from interface: CfnFleet.ScalingPolicyProperty

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.

Specified by:

getMetricName in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-metricname

getName

public final String getName()

Description copied from interface: CfnFleet.ScalingPolicyProperty

A descriptive label that is associated with a fleet's scaling policy.

Policy names do not need to be unique.

Specified by:

getName in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-name

getComparisonOperator

public final String getComparisonOperator()

Description copied from interface: CfnFleet.ScalingPolicyProperty

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

Specified by:

getComparisonOperator in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-comparisonoperator

getEvaluationPeriods

public final Number getEvaluationPeriods()

Description copied from interface: CfnFleet.ScalingPolicyProperty

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

Specified by:

getEvaluationPeriods in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-evaluationperiods

getLocation

public final String getLocation()

Description copied from interface: CfnFleet.ScalingPolicyProperty

The fleet location.

Specified by:

getLocation in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-location

getPolicyType

public final String getPolicyType()

Description copied from interface: CfnFleet.ScalingPolicyProperty

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 .

Specified by:

getPolicyType in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-policytype

getScalingAdjustment

public final Number getScalingAdjustment()

Description copied from interface: CfnFleet.ScalingPolicyProperty

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

Specified by:

getScalingAdjustment in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustment

getScalingAdjustmentType

public final String getScalingAdjustmentType()

Description copied from interface: CfnFleet.ScalingPolicyProperty

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.

Specified by:

getScalingAdjustmentType in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-scalingadjustmenttype

getStatus

public final String getStatus()

Description copied from interface: CfnFleet.ScalingPolicyProperty

Current status of the scaling policy.

The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.

• ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
• UPDATE_REQUESTED -- A request to update the scaling policy has been received.
• UPDATING -- A change is being made to the scaling policy.
• DELETE_REQUESTED -- 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.

Specified by:

getStatus in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-status

getTargetConfiguration

public final Object getTargetConfiguration()

Description copied from interface: CfnFleet.ScalingPolicyProperty

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

Specified by:

getTargetConfiguration in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-targetconfiguration

getThreshold

public final Number getThreshold()

Description copied from interface: CfnFleet.ScalingPolicyProperty

Metric value used to trigger a scaling event.

Specified by:

getThreshold in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-threshold

getUpdateStatus

public final String getUpdateStatus()

Description copied from interface: CfnFleet.ScalingPolicyProperty

The current status of the fleet's scaling policies in a requested fleet location.

The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

Specified by:

getUpdateStatus in interface CfnFleet.ScalingPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-scalingpolicy.html#cfn-gamelift-fleet-scalingpolicy-updatestatus

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object