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

Class: Aws::GameLift::Types::PutScalingPolicyInput

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

Overview

Note:

When making an API call, you may pass PutScalingPolicyInput data as a hash:

{
  name: "NonZeroAndMaxString", # required
  fleet_id: "FleetId", # required
  scaling_adjustment: 1, # required
  scaling_adjustment_type: "ChangeInCapacity", # required, accepts ChangeInCapacity, ExactCapacity, PercentChangeInCapacity
  threshold: 1.0, # required
  comparison_operator: "GreaterThanOrEqualToThreshold", # required, accepts GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold
  evaluation_periods: 1, # required
  metric_name: "ActivatingGameSessions", # required, accepts ActivatingGameSessions, ActiveGameSessions, ActiveInstances, AvailableGameSessions, AvailablePlayerSessions, CurrentPlayerSessions, IdleInstances, PercentAvailableGameSessions, PercentIdleInstances, QueueDepth, WaitTime
}

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#comparison_operatorString

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

Returns:

  • (String)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :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)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

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

#fleet_idString

Unique identifier for a fleet to apply this policy to.

Returns:

  • (String)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :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 includes 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)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :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. A fleet can have only one scaling policy with the same name.

Returns:

  • (String)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

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

#scaling_adjustmentInteger

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

Returns:

  • (Integer)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :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; for example, a value of "-10" scales the fleet down by 10%.

Returns:

  • (String)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

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

#thresholdFloat

Metric value used to trigger a scaling event.

Returns:

  • (Float)


4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4544

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