You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::ScalingPolicy

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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:

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

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

Possible values:

  • GreaterThanOrEqualToThreshold
  • GreaterThanThreshold
  • LessThanThreshold
  • LessThanOrEqualToThreshold

Returns:

  • (String)

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

#evaluation_periodsInteger

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

Returns:

  • (Integer)

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

#fleet_idString

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

Returns:

  • (String)

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

#metric_nameString

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.

    Possible values:

    • ActivatingGameSessions
    • ActiveGameSessions
    • ActiveInstances
    • AvailableGameSessions
    • AvailablePlayerSessions
    • CurrentPlayerSessions
    • IdleInstances
    • PercentAvailableGameSessions
    • PercentIdleInstances
    • QueueDepth
    • WaitTime

Returns:

  • (String)

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

#nameString

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

Returns:

  • (String)

    Descriptive label that is associated with a scaling policy.

#scaling_adjustmentInteger

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

Returns:

  • (Integer)

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

#scaling_adjustment_typeString

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.

    Possible values:

    • ChangeInCapacity
    • ExactCapacity
    • PercentChangeInCapacity

Returns:

  • (String)

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

#statusString

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.

    Possible values:

    • ACTIVE
    • UPDATE_REQUESTED
    • UPDATING
    • DELETE_REQUESTED
    • DELETING
    • DELETED
    • ERROR

Returns:

  • (String)

    Current status of the scaling policy.

#thresholdFloat

Metric value used to trigger a scaling event.

Returns:

  • (Float)

    Metric value used to trigger a scaling event.