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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

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:

  • CreateFleet

  • ListFleets

  • Describe fleets:

    • DescribeFleetAttributes

    • DescribeFleetPortSettings

    • DescribeFleetUtilization

    • DescribeRuntimeConfiguration

    • DescribeFleetEvents

  • Update fleets:

    • UpdateFleetAttributes

    • UpdateFleetCapacity

    • UpdateFleetPortSettings

    • UpdateRuntimeConfiguration

  • Manage fleet capacity:

    • DescribeFleetCapacity

    • UpdateFleetCapacity

    • PutScalingPolicy (automatic scaling)

    • DescribeScalingPolicies (automatic scaling)

    • DeleteScalingPolicy (automatic scaling)

    • DescribeEC2InstanceLimits

  • DeleteFleet

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

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

Returns:

  • (String)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

#evaluation_periodsInteger

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

Returns:

  • (Integer)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

#fleet_idString

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

Returns:

  • (String)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

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

Returns:

  • (String)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

#scaling_adjustmentInteger

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

Returns:

  • (Integer)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

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

Returns:

  • (String)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

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

Returns:

  • (String)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end

#thresholdFloat

Metric value used to trigger a scaling event.

Returns:

  • (Float)


5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 5326

class ScalingPolicy < Struct.new(
  :fleet_id,
  :name,
  :status,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :comparison_operator,
  :threshold,
  :evaluation_periods,
  :metric_name)
  include Aws::Structure
end