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.

Operations related to fleet capacity scaling include:

Inheritance Hierarchy

System.Object
  Amazon.GameLift.Model.ScalingPolicy

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

Syntax

C#
public class ScalingPolicy

The ScalingPolicy type exposes the following members

Constructors

NameDescription
Public Method ScalingPolicy()

Properties

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

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 PolicyType Amazon.GameLift.PolicyType

Gets and sets the property PolicyType.

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.

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 can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.

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

Public Property TargetConfiguration Amazon.GameLift.Model.TargetConfiguration

Gets and sets the property TargetConfiguration.

Object that contains settings for a target-based scaling policy.

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