software.amazon.awscdk.services.gamelift

Interface CfnGameServerGroup.AutoScalingPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGameServerGroup.AutoScalingPolicyProperty.Jsii$Proxy

Enclosing class:

CfnGameServerGroup

@Stability(value=Stable)
public static interface CfnGameServerGroup.AutoScalingPolicyProperty
extends software.amazon.jsii.JsiiSerializable

*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 software.amazon.awscdk.services.gamelift.*;
 AutoScalingPolicyProperty autoScalingPolicyProperty = AutoScalingPolicyProperty.builder()
         .targetTrackingConfiguration(TargetTrackingConfigurationProperty.builder()
                 .targetValue(123)
                 .build())
         // the properties below are optional
         .estimatedInstanceWarmup(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnGameServerGroup.AutoScalingPolicyProperty.Builder A builder for CfnGameServerGroup.AutoScalingPolicyProperty
static class	CfnGameServerGroup.AutoScalingPolicyProperty.Jsii$Proxy An implementation for CfnGameServerGroup.AutoScalingPolicyProperty

Method Summary

Modifier and Type	Method and Description
static CfnGameServerGroup.AutoScalingPolicyProperty.Builder	builder()
default Number	getEstimatedInstanceWarmup() Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.
Object	getTargetTrackingConfiguration() Settings for a target-based scaling policy applied to Auto Scaling group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTargetTrackingConfiguration

@Stability(value=Stable)
 @NotNull
Object getTargetTrackingConfiguration()

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.

getEstimatedInstanceWarmup

@Stability(value=Stable)
 @Nullable
default Number getEstimatedInstanceWarmup()

Length of time, in seconds, it takes for a new instance to start new game server processes and register with 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.

builder

@Stability(value=Stable)
static CfnGameServerGroup.AutoScalingPolicyProperty.Builder builder()

Returns:

a CfnGameServerGroup.AutoScalingPolicyProperty.Builder of CfnGameServerGroup.AutoScalingPolicyProperty