AWS SDK for C++
1.8.129
AWS SDK for C++
|
#include <ScalingPolicy.h>
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
DescribeFleetCapacity
UpdateFleetCapacity
DescribeEC2InstanceLimits
Manage scaling policies:
PutScalingPolicy (auto-scaling)
DescribeScalingPolicies (auto-scaling)
DeleteScalingPolicy (auto-scaling)
Manage fleet actions:
StartFleetActions
StopFleetActions
Definition at line 45 of file ScalingPolicy.h.
Aws::GameLift::Model::ScalingPolicy::ScalingPolicy | ( | ) |
Aws::GameLift::Model::ScalingPolicy::ScalingPolicy | ( | Aws::Utils::Json::JsonView | jsonValue | ) |
|
inline |
Comparison operator to use when measuring a metric against the threshold value.
Definition at line 365 of file ScalingPolicy.h.
|
inline |
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
Definition at line 423 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 64 of file ScalingPolicy.h.
|
inline |
Comparison operator to use when measuring a metric against the threshold value.
Definition at line 359 of file ScalingPolicy.h.
|
inline |
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
Definition at line 417 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 58 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 466 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 107 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 627 of file ScalingPolicy.h.
|
inline |
Amount of adjustment to make, based on the scaling adjustment type.
Definition at line 264 of file ScalingPolicy.h.
|
inline |
The 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.
Definition at line 292 of file ScalingPolicy.h.
|
inline |
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 (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
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.
Definition at line 168 of file ScalingPolicy.h.
|
inline |
The settings for a target-based scaling policy.
Definition at line 683 of file ScalingPolicy.h.
|
inline |
Metric value used to trigger a scaling event.
Definition at line 395 of file ScalingPolicy.h.
Aws::Utils::Json::JsonValue Aws::GameLift::Model::ScalingPolicy::Jsonize | ( | ) | const |
|
inline |
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.
Definition at line 496 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 113 of file ScalingPolicy.h.
ScalingPolicy& Aws::GameLift::Model::ScalingPolicy::operator= | ( | Aws::Utils::Json::JsonView | jsonValue | ) |
|
inline |
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.
Definition at line 637 of file ScalingPolicy.h.
|
inline |
Amount of adjustment to make, based on the scaling adjustment type.
Definition at line 269 of file ScalingPolicy.h.
|
inline |
The 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.
Definition at line 304 of file ScalingPolicy.h.
|
inline |
Comparison operator to use when measuring a metric against the threshold value.
Definition at line 377 of file ScalingPolicy.h.
|
inline |
Comparison operator to use when measuring a metric against the threshold value.
Definition at line 371 of file ScalingPolicy.h.
|
inline |
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
Definition at line 429 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 76 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 70 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 82 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 526 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 556 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 125 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 119 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 131 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 647 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 657 of file ScalingPolicy.h.
|
inline |
Amount of adjustment to make, based on the scaling adjustment type.
Definition at line 274 of file ScalingPolicy.h.
|
inline |
The 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.
Definition at line 316 of file ScalingPolicy.h.
|
inline |
The 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.
Definition at line 328 of file ScalingPolicy.h.
|
inline |
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 (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
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.
Definition at line 204 of file ScalingPolicy.h.
|
inline |
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 (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
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.
Definition at line 222 of file ScalingPolicy.h.
|
inline |
The settings for a target-based scaling policy.
Definition at line 693 of file ScalingPolicy.h.
|
inline |
The settings for a target-based scaling policy.
Definition at line 698 of file ScalingPolicy.h.
|
inline |
Metric value used to trigger a scaling event.
Definition at line 405 of file ScalingPolicy.h.
|
inline |
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 (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
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.
Definition at line 186 of file ScalingPolicy.h.
|
inline |
The settings for a target-based scaling policy.
Definition at line 688 of file ScalingPolicy.h.
|
inline |
Metric value used to trigger a scaling event.
Definition at line 400 of file ScalingPolicy.h.
|
inline |
Comparison operator to use when measuring a metric against the threshold value.
Definition at line 389 of file ScalingPolicy.h.
|
inline |
Comparison operator to use when measuring a metric against the threshold value.
Definition at line 383 of file ScalingPolicy.h.
|
inline |
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
Definition at line 435 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 94 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 88 of file ScalingPolicy.h.
|
inline |
A unique identifier for a fleet that is associated with this scaling policy.
Definition at line 100 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 586 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 616 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 143 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 137 of file ScalingPolicy.h.
|
inline |
A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
Definition at line 149 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 667 of file ScalingPolicy.h.
|
inline |
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.
Definition at line 677 of file ScalingPolicy.h.
|
inline |
Amount of adjustment to make, based on the scaling adjustment type.
Definition at line 279 of file ScalingPolicy.h.
|
inline |
The 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.
Definition at line 340 of file ScalingPolicy.h.
|
inline |
The 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.
Definition at line 352 of file ScalingPolicy.h.
|
inline |
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 (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
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.
Definition at line 240 of file ScalingPolicy.h.
|
inline |
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 (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
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.
Definition at line 258 of file ScalingPolicy.h.
|
inline |
The settings for a target-based scaling policy.
Definition at line 703 of file ScalingPolicy.h.
|
inline |
The settings for a target-based scaling policy.
Definition at line 708 of file ScalingPolicy.h.
|
inline |
Metric value used to trigger a scaling event.
Definition at line 410 of file ScalingPolicy.h.