libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.PutScalingPolicy

Description

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: "If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%."

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to "RuleBased". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Related actions

DescribeFleetCapacity | UpdateFleetCapacity | DescribeEC2InstanceLimits | PutScalingPolicy | DescribeScalingPolicies | DeleteScalingPolicy | StopFleetActions | StartFleetActions | All APIs by task

Synopsis

Creating a Request

data PutScalingPolicy Source #

Represents the input for a request operation.

See: newPutScalingPolicy smart constructor.

Constructors

PutScalingPolicy' 

Fields

  • scalingAdjustmentType :: Maybe ScalingAdjustmentType

    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; for example, a value of "-10" scales the fleet down by 10%.
  • evaluationPeriods :: Maybe Natural

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

  • policyType :: Maybe PolicyType

    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.

  • comparisonOperator :: Maybe ComparisonOperatorType

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

  • threshold :: Maybe Double

    Metric value used to trigger a scaling event.

  • scalingAdjustment :: Maybe Int

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

  • targetConfiguration :: Maybe TargetConfiguration

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

  • name :: Text

    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.

  • fleetId :: Text

    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.

  • metricName :: MetricName

    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.

Instances

Instances details
Eq PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Read PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Show PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Generic PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Associated Types

type Rep PutScalingPolicy :: Type -> Type #

NFData PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Methods

rnf :: PutScalingPolicy -> () #

Hashable PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

ToJSON PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

AWSRequest PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Associated Types

type AWSResponse PutScalingPolicy #

ToHeaders PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

ToPath PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

ToQuery PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

type Rep PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

type AWSResponse PutScalingPolicy Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

newPutScalingPolicy Source #

Create a value of PutScalingPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:scalingAdjustmentType:PutScalingPolicy', putScalingPolicy_scalingAdjustmentType - 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; for example, a value of "-10" scales the fleet down by 10%.

$sel:evaluationPeriods:PutScalingPolicy', putScalingPolicy_evaluationPeriods - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

$sel:policyType:PutScalingPolicy', putScalingPolicy_policyType - 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.

$sel:comparisonOperator:PutScalingPolicy', putScalingPolicy_comparisonOperator - Comparison operator to use when measuring the metric against the threshold value.

$sel:threshold:PutScalingPolicy', putScalingPolicy_threshold - Metric value used to trigger a scaling event.

$sel:scalingAdjustment:PutScalingPolicy', putScalingPolicy_scalingAdjustment - Amount of adjustment to make, based on the scaling adjustment type.

$sel:targetConfiguration:PutScalingPolicy', putScalingPolicy_targetConfiguration - An object that contains settings for a target-based scaling policy.

$sel:name:PutScalingPolicy', putScalingPolicy_name - 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.

$sel:fleetId:PutScalingPolicy', putScalingPolicy_fleetId - 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.

$sel:metricName:PutScalingPolicy', putScalingPolicy_metricName - 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.

Request Lenses

putScalingPolicy_scalingAdjustmentType :: Lens' PutScalingPolicy (Maybe ScalingAdjustmentType) Source #

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; for example, a value of "-10" scales the fleet down by 10%.

putScalingPolicy_evaluationPeriods :: Lens' PutScalingPolicy (Maybe Natural) Source #

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

putScalingPolicy_policyType :: Lens' PutScalingPolicy (Maybe PolicyType) Source #

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.

putScalingPolicy_comparisonOperator :: Lens' PutScalingPolicy (Maybe ComparisonOperatorType) Source #

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

putScalingPolicy_threshold :: Lens' PutScalingPolicy (Maybe Double) Source #

Metric value used to trigger a scaling event.

putScalingPolicy_scalingAdjustment :: Lens' PutScalingPolicy (Maybe Int) Source #

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

putScalingPolicy_targetConfiguration :: Lens' PutScalingPolicy (Maybe TargetConfiguration) Source #

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

putScalingPolicy_name :: Lens' PutScalingPolicy Text Source #

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.

putScalingPolicy_fleetId :: Lens' PutScalingPolicy Text Source #

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.

putScalingPolicy_metricName :: Lens' PutScalingPolicy MetricName Source #

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.

Destructuring the Response

data PutScalingPolicyResponse Source #

Represents the returned data in response to a request operation.

See: newPutScalingPolicyResponse smart constructor.

Constructors

PutScalingPolicyResponse' 

Fields

  • name :: Maybe Text

    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq PutScalingPolicyResponse Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Read PutScalingPolicyResponse Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Show PutScalingPolicyResponse Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Generic PutScalingPolicyResponse Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

Associated Types

type Rep PutScalingPolicyResponse :: Type -> Type #

NFData PutScalingPolicyResponse Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

type Rep PutScalingPolicyResponse Source # 
Instance details

Defined in Amazonka.GameLift.PutScalingPolicy

type Rep PutScalingPolicyResponse = D1 ('MetaData "PutScalingPolicyResponse" "Amazonka.GameLift.PutScalingPolicy" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "PutScalingPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutScalingPolicyResponse Source #

Create a value of PutScalingPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:name:PutScalingPolicy', putScalingPolicyResponse_name - A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

$sel:httpStatus:PutScalingPolicyResponse', putScalingPolicyResponse_httpStatus - The response's http status code.

Response Lenses

putScalingPolicyResponse_name :: Lens' PutScalingPolicyResponse (Maybe Text) Source #

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.