Package software.amazon.awscdk.services.gamelift

Interface CfnFleet.ScalingPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.ScalingPolicyProperty.Jsii$Proxy

Enclosing class:

CfnFleet

@Stability(Stable)
public static interface CfnFleet.ScalingPolicyProperty
extends software.amazon.jsii.JsiiSerializable

Rule that controls how a fleet is scaled.

Scaling policies are uniquely identified by the combination of name and fleet ID.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 ScalingPolicyProperty scalingPolicyProperty = ScalingPolicyProperty.builder()
         .metricName("metricName")
         .name("name")
         // the properties below are optional
         .comparisonOperator("comparisonOperator")
         .evaluationPeriods(123)
         .location("location")
         .policyType("policyType")
         .scalingAdjustment(123)
         .scalingAdjustmentType("scalingAdjustmentType")
         .status("status")
         .targetConfiguration(TargetConfigurationProperty.builder()
                 .targetValue(123)
                 .build())
         .threshold(123)
         .updateStatus("updateStatus")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleet.ScalingPolicyProperty.Builder	A builder for CfnFleet.ScalingPolicyProperty
static final class	CfnFleet.ScalingPolicyProperty.Jsii$Proxy	An implementation for CfnFleet.ScalingPolicyProperty

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetricName

@Stability(Stable)
@NotNull
String getMetricName()

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:

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

getName

@Stability(Stable)
@NotNull
String getName()

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

Policy names do not need to be unique.

See Also:

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

getComparisonOperator

@Stability(Stable)
@Nullable
default String getComparisonOperator()

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

See Also:

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

getEvaluationPeriods

@Stability(Stable)
@Nullable
default Number getEvaluationPeriods()

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

See Also:

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

getLocation

@Stability(Stable)
@Nullable
default String getLocation()

The fleet location.

See Also:

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

getPolicyType

@Stability(Stable)
@Nullable
default String getPolicyType()

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:

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

getScalingAdjustment

@Stability(Stable)
@Nullable
default Number getScalingAdjustment()

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

See Also:

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

getScalingAdjustmentType

@Stability(Stable)
@Nullable
default String getScalingAdjustmentType()

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.

See Also:

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

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

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.

See Also:

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

getTargetConfiguration

@Stability(Stable)
@Nullable
default Object getTargetConfiguration()

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

See Also:

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

getThreshold

@Stability(Stable)
@Nullable
default Number getThreshold()

Metric value used to trigger a scaling event.

See Also:

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

getUpdateStatus

@Stability(Stable)
@Nullable
default String getUpdateStatus()

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.

See Also:

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

builder

@Stability(Stable)
static CfnFleet.ScalingPolicyProperty.Builder builder()

Returns:

a CfnFleet.ScalingPolicyProperty.Builder of CfnFleet.ScalingPolicyProperty