1.204.0

interface AutoScalingPolicyProperty

LanguageType name
.NETAmazon.CDK.AWS.GameLift.CfnGameServerGroup.AutoScalingPolicyProperty
Javasoftware.amazon.awscdk.services.gamelift.CfnGameServerGroup.AutoScalingPolicyProperty
Pythonaws_cdk.aws_gamelift.CfnGameServerGroup.AutoScalingPolicyProperty
TypeScript @aws-cdk/aws-gamelift » CfnGameServerGroup » AutoScalingPolicyProperty

This data type is used with the GameLift FleetIQ and game server groups..

Configuration settings for intelligent automatic scaling that uses target tracking. After the Auto Scaling group is created, all updates to Auto Scaling policies, including changing this policy and adding or removing other policies, is done directly on the Auto Scaling group.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as gamelift from '@aws-cdk/aws-gamelift';
const autoScalingPolicyProperty: gamelift.CfnGameServerGroup.AutoScalingPolicyProperty = {
  targetTrackingConfiguration: {
    targetValue: 123,
  },

  // the properties below are optional
  estimatedInstanceWarmup: 123,
};

Properties

NameTypeDescription
targetTrackingConfigurationIResolvable | TargetTrackingConfigurationPropertySettings for a target-based scaling policy applied to Auto Scaling group.
estimatedInstanceWarmup?numberLength of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift FleetIQ.

targetTrackingConfiguration

Type: IResolvable | TargetTrackingConfigurationProperty

Settings for a target-based scaling policy applied to Auto Scaling group.

These settings are used to create a target-based policy that tracks the GameLift FleetIQ metric PercentUtilizedGameServers and specifies a target value for the metric. As player usage changes, the policy triggers to adjust the game server group capacity so that the metric returns to the target value.

estimatedInstanceWarmup?

Type: number (optional)

Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift FleetIQ.

Specifying a warm-up time can be useful, particularly with game servers that take a long time to start up, because it avoids prematurely starting new instances.

← PreviousNext →