Experimental
@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
AutoScalingPolicy Struct
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.
| Stability | Experimental |
|---|---|
| Source | lib/game-server-group.ts |
Example
declare const launchTemplate: ec2.ILaunchTemplate;
declare const vpc: ec2.IVpc;
new gamelift.GameServerGroup(this, 'Game server group', {
gameServerGroupName: 'sample-gameservergroup-name',
instanceDefinitions: [{
instanceType: ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE),
},
{
instanceType: ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),
}],
launchTemplate: launchTemplate,
vpc: vpc,
autoScalingPolicy: {
estimatedInstanceWarmup: Duration.minutes(5),
targetTrackingConfiguration: 5
}
});
# launch_template: ec2.ILaunchTemplate
# vpc: ec2.IVpc
gamelift.GameServerGroup(self, "Game server group",
game_server_group_name="sample-gameservergroup-name",
instance_definitions=[gamelift.InstanceDefinition(
instance_type=ec2.InstanceType.of(ec2.InstanceClass.C5, ec2.InstanceSize.LARGE)
), gamelift.InstanceDefinition(
instance_type=ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE)
)],
launch_template=launch_template,
vpc=vpc,
auto_scaling_policy=gamelift.AutoScalingPolicy(
estimated_instance_warmup=Duration.minutes(5),
target_tracking_configuration=5
)
)
ILaunchTemplate launchTemplate;
IVpc vpc;
GameServerGroup.Builder.create(this, "Game server group")
.gameServerGroupName("sample-gameservergroup-name")
.instanceDefinitions(List.of(InstanceDefinition.builder()
.instanceType(InstanceType.of(InstanceClass.C5, InstanceSize.LARGE))
.build(), InstanceDefinition.builder()
.instanceType(InstanceType.of(InstanceClass.C4, InstanceSize.LARGE))
.build()))
.launchTemplate(launchTemplate)
.vpc(vpc)
.autoScalingPolicy(AutoScalingPolicy.builder()
.estimatedInstanceWarmup(Duration.minutes(5))
.targetTrackingConfiguration(5)
.build())
.build();
// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
ILaunchTemplate launchTemplate;
IVpc vpc;
new GameServerGroup(this, "Game server group", new GameServerGroupProps {
GameServerGroupName = "sample-gameservergroup-name",
InstanceDefinitions = new [] { new InstanceDefinition {
InstanceType = InstanceType.Of(InstanceClass.C5, InstanceSize.LARGE)
}, new InstanceDefinition {
InstanceType = InstanceType.Of(InstanceClass.C4, InstanceSize.LARGE)
} },
LaunchTemplate = launchTemplate,
Vpc = vpc,
AutoScalingPolicy = new AutoScalingPolicy {
EstimatedInstanceWarmup = Duration.Minutes(5),
TargetTrackingConfiguration = 5
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
var launchTemplate ILaunchTemplate
var vpc IVpc
gamelift.NewGameServerGroup(this, jsii.String("Game server group"), &GameServerGroupProps{
GameServerGroupName: jsii.String("sample-gameservergroup-name"),
InstanceDefinitions: []InstanceDefinition{
&InstanceDefinition{
InstanceType: ec2.InstanceType_Of(ec2.InstanceClass_C5, ec2.InstanceSize_LARGE),
},
&InstanceDefinition{
InstanceType: ec2.InstanceType_*Of(ec2.InstanceClass_C4, ec2.InstanceSize_LARGE),
},
},
LaunchTemplate: launchTemplate,
Vpc: vpc,
AutoScalingPolicy: &AutoScalingPolicy{
EstimatedInstanceWarmup: awscdk.Duration_Minutes(jsii.Number(5)),
TargetTrackingConfiguration: jsii.Number(5),
},
})
Properties
estimatedInstanceWarmupoptionalDurationestimated_instance_warmupoptionalDurationestimatedInstanceWarmupoptionalDurationEstimatedInstanceWarmupoptionalDurationEstimatedInstanceWarmupoptionalDuration #Default: no instance warmup duration settled
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.
targetTrackingConfigurationnumbertarget_tracking_configurationint | floattargetTrackingConfigurationNumberTargetTrackingConfigurationdoubleTargetTrackingConfiguration*float64 required #notes
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.