Class: Aws::GameLift::Types::ScalingPolicy
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::ScalingPolicy
- 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#comparison_operator ⇒ String
Comparison operator to use when measuring a 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_arn ⇒ String
The Amazon Resource Name ([ARN][1]) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
-
#fleet_id ⇒ String
A unique identifier for the fleet that is associated with this scaling policy.
-
#location ⇒ String
The fleet location.
-
#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.
-
#status ⇒ String
Current status of the scaling policy.
-
#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.
-
#update_status ⇒ String
The current status of the fleet's scaling policies in a requested fleet location.
Instance Attribute Details
#comparison_operator ⇒ String
Comparison operator to use when measuring a metric against the threshold value.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) 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.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#fleet_arn ⇒ String
The Amazon Resource Name (ARN) that is assigned to a Amazon
GameLift fleet resource and uniquely identifies it. ARNs are unique
across all Regions. Format is
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912
.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#fleet_id ⇒ String
A unique identifier for the fleet that is associated with this scaling policy.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#location ⇒ String
The fleet location.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) 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.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) 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.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) 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.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#scaling_adjustment ⇒ Integer
Amount of adjustment to make, based on the scaling adjustment type.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) 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.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
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. If the policy is suspended for a
fleet, the policy status does not change.
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.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#target_configuration ⇒ Types::TargetConfiguration
An object that contains settings for a target-based scaling policy.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#threshold ⇒ Float
Metric value used to trigger a scaling event.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |
#update_status ⇒ String
The current status of the fleet's scaling policies in a requested
fleet location. The status PENDING_UPDATE
indicates that an update
was requested for the fleet but has not yet been completed for the
location.
9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 9297 class ScalingPolicy < Struct.new( :fleet_id, :fleet_arn, :name, :status, :scaling_adjustment, :scaling_adjustment_type, :comparison_operator, :threshold, :evaluation_periods, :metric_name, :policy_type, :target_configuration, :update_status, :location) SENSITIVE = [] include Aws::Structure end |