All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnGameServerGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-07-04T12:43:07.844Z") @Stability(Stable) public interface CfnGameServerGroupProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGameServerGroup.

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.*;
 CfnGameServerGroupProps cfnGameServerGroupProps = CfnGameServerGroupProps.builder()
         .gameServerGroupName("gameServerGroupName")
         .instanceDefinitions(List.of(InstanceDefinitionProperty.builder()
                 .instanceType("instanceType")
                 // the properties below are optional
                 .weightedCapacity("weightedCapacity")
                 .build()))
         .roleArn("roleArn")
         // the properties below are optional
         .autoScalingPolicy(AutoScalingPolicyProperty.builder()
                 .targetTrackingConfiguration(TargetTrackingConfigurationProperty.builder()
                         .targetValue(123)
                         .build())
                 // the properties below are optional
                 .estimatedInstanceWarmup(123)
                 .build())
         .balancingStrategy("balancingStrategy")
         .deleteOption("deleteOption")
         .gameServerProtectionPolicy("gameServerProtectionPolicy")
         .launchTemplate(LaunchTemplateProperty.builder()
                 .launchTemplateId("launchTemplateId")
                 .launchTemplateName("launchTemplateName")
                 .version("version")
                 .build())
         .maxSize(123)
         .minSize(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSubnets(List.of("vpcSubnets"))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnGameServerGroupProps.Builder

A builder for CfnGameServerGroupProps

static final class

CfnGameServerGroupProps.Jsii$Proxy

An implementation for CfnGameServerGroupProps
Method Summary

Modifier and Type

Method

Description

static CfnGameServerGroupProps.Builder

builder()

default Object

getAutoScalingPolicy()

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.

default String

getBalancingStrategy()

Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.

default String

getDeleteOption()

The type of delete to perform.

String

getGameServerGroupName()

A developer-defined identifier for the game server group.

default String

getGameServerProtectionPolicy()

A flag that indicates whether instances in the game server group are protected from early termination.

Object

getInstanceDefinitions()

The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

default Object

getLaunchTemplate()

The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

default Number

getMaxSize()

The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.

default Number

getMinSize()

The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.

String

getRoleArn()

The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.

default List<CfnTag>

getTags()

A list of labels to assign to the new game server group resource.

default List<String>

getVpcSubnets()

A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getGameServerGroupName
  
  @Stability(Stable) @NotNull String getGameServerGroupName()
  
  A developer-defined identifier for the game server group.
  The name is unique for each Region in each AWS account.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameservergroupname
- getInstanceDefinitions
  
  @Stability(Stable) @NotNull Object getInstanceDefinitions()
  
  The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-instancedefinitions
- getRoleArn
  
  @Stability(Stable) @NotNull String getRoleArn()
  
  The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-rolearn
- getAutoScalingPolicy
  
  @Stability(Stable) @Nullable default Object getAutoScalingPolicy()
  
  Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
  The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-autoscalingpolicy
- getBalancingStrategy
  
  @Stability(Stable) @Nullable default String getBalancingStrategy()
  Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
  Method options include the following:
  
  SPOT_ONLY - Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.
  
  SPOT_PREFERRED - (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.
  
  ON_DEMAND_ONLY - Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-balancingstrategy
- getDeleteOption
  
  @Stability(Stable) @Nullable default String getDeleteOption()
  The type of delete to perform.
  To delete a game server group, specify the DeleteOption . Options include the following:
  
  SAFE_DELETE – (default) Terminates the game server group and Amazon EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.
  
  FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the Amazon EC2 Auto Scaling group.
  
  RETAIN – Does a safe delete of the game server group but retains the Amazon EC2 Auto Scaling group as is.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-deleteoption
- getGameServerProtectionPolicy
  
  @Stability(Stable) @Nullable default String getGameServerProtectionPolicy()
  
  A flag that indicates whether instances in the game server group are protected from early termination.
  Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-gameserverprotectionpolicy
- getLaunchTemplate
  
  @Stability(Stable) @Nullable default Object getLaunchTemplate()
  
  The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
  You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon Elastic Compute Cloud Auto Scaling User Guide . After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
  
  If you specify network interfaces in your launch template, you must explicitly set the property AssociatePublicIpAddress to "true". If no network interface is specified in the launch template, Amazon GameLift Servers FleetIQ uses your account's default VPC.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-launchtemplate
- getMaxSize
  
  @Stability(Stable) @Nullable default Number getMaxSize()
  
  The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
  During automatic scaling events, Amazon GameLift Servers FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-maxsize
- getMinSize
  
  @Stability(Stable) @Nullable default Number getMinSize()
  
  The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
  During automatic scaling events, Amazon GameLift Servers FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the AWS console or APIs.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-minsize
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  A list of labels to assign to the new game server group resource.
  Tags are developer-defined key-value pairs. Tagging AWS resources is useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags, respectively. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-tags
- getVpcSubnets
  
  @Stability(Stable) @Nullable default List<String> getVpcSubnets()
  
  A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
  By default, all Amazon GameLift Servers FleetIQ-supported Availability Zones are used. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-gameservergroup.html#cfn-gamelift-gameservergroup-vpcsubnets
- builder
  
  @Stability(Stable) static CfnGameServerGroupProps.Builder builder()
  
  Returns:
  
  a CfnGameServerGroupProps.Builder of CfnGameServerGroupProps

Interface CfnGameServerGroupProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getGameServerGroupName

getInstanceDefinitions

getRoleArn

getAutoScalingPolicy

getBalancingStrategy

getDeleteOption

getGameServerProtectionPolicy

getLaunchTemplate

getMaxSize

getMinSize

getTags

getVpcSubnets

builder