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

Inherits:

Struct

• Object
• Struct
• Aws::GameLift::Types::PutScalingPolicyInput

Includes:

Structure

Defined in:

lib/aws-sdk-gamelift/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #comparison_operator ⇒ String

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

• #evaluation_periods ⇒ Integer

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

• #fleet_id ⇒ String

  A unique identifier for the fleet to apply this policy to.

• #metric_name ⇒ String

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

• #name ⇒ String

  A descriptive label that is associated with a fleet’s scaling policy.

• #policy_type ⇒ String

  The type of scaling policy to create.

• #scaling_adjustment ⇒ Integer

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

• #scaling_adjustment_type ⇒ String

  The type of adjustment to make to a fleet’s instance count:.

• #target_configuration ⇒ Types::TargetConfiguration

  An object that contains settings for a target-based scaling policy.

• #threshold ⇒ Float

  Metric value used to trigger a scaling event.

Instance Attribute Details

#comparison_operator ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_periods ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_id ⇒ String

A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet cannot be in any of the following statuses: ERROR or DELETING.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

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.

[1]: docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A descriptive label that is associated with a fleet’s scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#policy_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_adjustment ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_adjustment_type ⇒ String

The type of adjustment to make to a fleet’s instance count:

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

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#target_configuration ⇒ Types::TargetConfiguration

An object that contains settings for a target-based scaling policy.

Returns:

• (Types::TargetConfiguration)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#threshold ⇒ Float

Metric value used to trigger a scaling event.

Returns:

• (Float)

# File 'lib/aws-sdk-gamelift/types.rb', line 8692

class PutScalingPolicyInput < Struct.new(
  :name,
  :fleet_id,
  :scaling_adjustment,
  :scaling_adjustment_type,
  :threshold,
  :comparison_operator,
  :evaluation_periods,
  :metric_name,
  :policy_type,
  :target_configuration)
  SENSITIVE = []
  include Aws::Structure
end