interface ScalingPolicyProperty

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnContainerFleet.ScalingPolicyProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnContainerFleet_ScalingPolicyProperty`
Java	`software.amazon.awscdk.services.gamelift.CfnContainerFleet.ScalingPolicyProperty`
Python	`aws_cdk.aws_gamelift.CfnContainerFleet.ScalingPolicyProperty`
TypeScript	`aws-cdk-lib` » `aws_gamelift` » `CfnContainerFleet` » `ScalingPolicyProperty`

Rule that controls how a fleet is scaled.

Scaling policies are uniquely identified by the combination of name and fleet ID.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const scalingPolicyProperty: gamelift.CfnContainerFleet.ScalingPolicyProperty = {
  metricName: 'metricName',
  name: 'name',

  // the properties below are optional
  comparisonOperator: 'comparisonOperator',
  evaluationPeriods: 123,
  policyType: 'policyType',
  scalingAdjustment: 123,
  scalingAdjustmentType: 'scalingAdjustmentType',
  targetConfiguration: {
    targetValue: 123,
  },
  threshold: 123,
};

Properties

Name	Type	Description
metricName	`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.
comparisonOperator?	`string`	Comparison operator to use when measuring a metric against the threshold value.
evaluationPeriods?	`number`	Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
policyType?	`string`	The type of scaling policy to create.
scalingAdjustment?	`number`	Amount of adjustment to make, based on the scaling adjustment type.
scalingAdjustmentType?	`string`	The type of adjustment to make to a fleet's instance count.
targetConfiguration?	`IResolvable` `\|` `TargetConfigurationProperty`	An object that contains settings for a target-based scaling policy.
threshold?	`number`	Metric value used to trigger a scaling event.

metricName

Type: 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.

name

Type: string

A descriptive label that is associated with a fleet's scaling policy.

Policy names do not need to be unique.

comparisonOperator?

Type: string (optional)

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

evaluationPeriods?

Type: number (optional)

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

policyType?

Type: string (optional)

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?

Type: number (optional)

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

scalingAdjustmentType?

Type: string (optional)

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.

targetConfiguration?

Type: IResolvable | TargetConfigurationProperty (optional)

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

threshold?

Type: number (optional)

Metric value used to trigger a scaling event.