Network.AWS.GameLift.PutScalingPolicy

Creates or updates a scaling policy for a fleet. An active scaling policy prompts GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.

A scaling policy rule statement has the following structure:

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

For example, this policy: "If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances" could be implemented as the following rule statement:

If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.

Creating a Request

putScalingPolicy

Arguments

:: Text

pspName

-> Text

pspFleetId

-> Int

pspScalingAdjustment

-> ScalingAdjustmentType

pspScalingAdjustmentType

-> Double

pspThreshold

-> ComparisonOperatorType

pspComparisonOperator

-> Natural

pspEvaluationPeriods

-> MetricName

pspMetricName

-> PutScalingPolicy

Creates a value of PutScalingPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pspName
• pspFleetId
• pspScalingAdjustment
• pspScalingAdjustmentType
• pspThreshold
• pspComparisonOperator
• pspEvaluationPeriods
• pspMetricName

data PutScalingPolicy

Represents the input for a request action.

See: putScalingPolicy smart constructor.

Instances

Eq PutScalingPolicy

Data PutScalingPolicy

Read PutScalingPolicy

Show PutScalingPolicy

Generic PutScalingPolicy

ToJSON PutScalingPolicy

Hashable PutScalingPolicy

AWSRequest PutScalingPolicy

ToPath PutScalingPolicy

ToHeaders PutScalingPolicy

ToQuery PutScalingPolicy

type Rep PutScalingPolicy

type Rs PutScalingPolicy = PutScalingPolicyResponse

Request Lenses

pspName :: Lens' PutScalingPolicy Text

Descriptive label associated with this scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

pspFleetId :: Lens' PutScalingPolicy Text

Unique identity for the fleet to scale with this policy.

pspScalingAdjustment :: Lens' PutScalingPolicy Int

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

pspScalingAdjustmentType :: Lens' PutScalingPolicy ScalingAdjustmentType

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

pspThreshold :: Lens' PutScalingPolicy Double

Metric value used to trigger a scaling event.

pspComparisonOperator :: Lens' PutScalingPolicy ComparisonOperatorType

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

pspEvaluationPeriods :: Lens' PutScalingPolicy Natural

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

pspMetricName :: Lens' PutScalingPolicy MetricName

Name of the Service-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.

Destructuring the Response

putScalingPolicyResponse

Arguments

:: Int

psprsResponseStatus

-> PutScalingPolicyResponse

Creates a value of PutScalingPolicyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• psprsName
• psprsResponseStatus

data PutScalingPolicyResponse

Represents the returned data in response to a request action.

See: putScalingPolicyResponse smart constructor.

Instances

Eq PutScalingPolicyResponse

Data PutScalingPolicyResponse

Read PutScalingPolicyResponse

Show PutScalingPolicyResponse

Generic PutScalingPolicyResponse

type Rep PutScalingPolicyResponse

Response Lenses

psprsName :: Lens' PutScalingPolicyResponse (Maybe Text)

Descriptive label associated with this scaling policy. Policy names do not need to be unique.

psprsResponseStatus :: Lens' PutScalingPolicyResponse Int

The response status code.