AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

Fleet-related operations include:

Inheritance Hierarchy


Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z


public class ScalingPolicy

The ScalingPolicy type exposes the following members


Public Method ScalingPolicy()


Public Property ComparisonOperator Amazon.GameLift.ComparisonOperatorType

Gets and sets the property ComparisonOperator.

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

Public Property EvaluationPeriods System.Int32

Gets and sets the property EvaluationPeriods.

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

Public Property FleetId System.String

Gets and sets the property FleetId.

Unique identifier for a fleet that is associated with this scaling policy.

Public Property MetricName Amazon.GameLift.MetricName

Gets and sets the property MetricName.

Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.

  • ActivatingGameSessions -- number of game sessions in the process of being created (game session status = ACTIVATING).

  • ActiveGameSessions -- number of game sessions currently running (game session status = ACTIVE).

  • CurrentPlayerSessions -- number of active or reserved player sessions (player session status = ACTIVE or RESERVED).

  • AvailablePlayerSessions -- number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number does include game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).

  • ActiveInstances -- number of instances currently running a game session.

  • IdleInstances -- number of instances not currently running a game session.

Public Property Name System.String

Gets and sets the property Name.

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

Public Property ScalingAdjustment System.Int32

Gets and sets the property ScalingAdjustment.

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

Public Property ScalingAdjustmentType Amazon.GameLift.ScalingAdjustmentType

Gets and sets the property ScalingAdjustmentType.

Type of adjustment to make to a fleet's instance count (see FleetCapacity):

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

Public Property Status Amazon.GameLift.ScalingStatusType

Gets and sets the property Status.

Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE status.

  • ACTIVE -- The scaling policy is currently in force.

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

Public Property Threshold System.Double

Gets and sets the property Threshold.

Metric value used to trigger a scaling event.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms