PutScalingPolicyInput

import type { PutScalingPolicyInput } from "https://aws-api.deno.dev/v0.3/services/gamelift.ts?docs=full";

Represents the input for a request operation.

interface PutScalingPolicyInput {

ComparisonOperator?: ComparisonOperatorType | null;

EvaluationPeriods?: number | null;

FleetId: string;

MetricName: MetricName;

Name: string;

PolicyType?: PolicyType | null;

ScalingAdjustment?: number | null;

ScalingAdjustmentType?: ScalingAdjustmentType | null;

TargetConfiguration?: TargetConfiguration | null;

Threshold?: number | null;

}

§Properties

ComparisonOperator?: ComparisonOperatorType | null

[src]

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

EvaluationPeriods?: number | null

[src]

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

FleetId: string

[src]

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

[src]

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.

Name: string

[src]

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.

PolicyType?: PolicyType | null

[src]

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.

ScalingAdjustment?: number | null

[src]

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

ScalingAdjustmentType?: ScalingAdjustmentType | null

[src]

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

TargetConfiguration?: TargetConfiguration | null

[src]

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

Threshold?: number | null

[src]

Metric value used to trigger a scaling event.