This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::GameLift::GameServerGroup
<a name="aws-resource-gamelift-gameservergroup"></a>

 **This operation is used with the Amazon GameLift FleetIQ solution and game server groups.** 

Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account, and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following: 
+ An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see [ Launching an Instance from a Launch Template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*. 
+ An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see [Create IAM roles for cross-service interaction](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html) in the *GameLift FleetIQ Developer Guide*.

To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

 **Learn more** 

 [GameLift FleetIQ Guide](https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html) 

## Syntax
<a name="aws-resource-gamelift-gameservergroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-gamelift-gameservergroup-syntax.json"></a>

```
{
  "Type" : "AWS::GameLift::GameServerGroup",
  "Properties" : {
      "[AutoScalingPolicy](#cfn-gamelift-gameservergroup-autoscalingpolicy)" : AutoScalingPolicy,
      "[BalancingStrategy](#cfn-gamelift-gameservergroup-balancingstrategy)" : String,
      "[DeleteOption](#cfn-gamelift-gameservergroup-deleteoption)" : String,
      "[GameServerGroupName](#cfn-gamelift-gameservergroup-gameservergroupname)" : String,
      "[GameServerProtectionPolicy](#cfn-gamelift-gameservergroup-gameserverprotectionpolicy)" : String,
      "[InstanceDefinitions](#cfn-gamelift-gameservergroup-instancedefinitions)" : [ InstanceDefinition, ... ],
      "[LaunchTemplate](#cfn-gamelift-gameservergroup-launchtemplate)" : LaunchTemplate,
      "[MaxSize](#cfn-gamelift-gameservergroup-maxsize)" : Number,
      "[MinSize](#cfn-gamelift-gameservergroup-minsize)" : Number,
      "[RoleArn](#cfn-gamelift-gameservergroup-rolearn)" : String,
      "[Tags](#cfn-gamelift-gameservergroup-tags)" : [ Tag, ... ],
      "[VpcSubnets](#cfn-gamelift-gameservergroup-vpcsubnets)" : [ String, ... ]
    }
}
```

### YAML
<a name="aws-resource-gamelift-gameservergroup-syntax.yaml"></a>

```
Type: AWS::GameLift::GameServerGroup
Properties:
  [AutoScalingPolicy](#cfn-gamelift-gameservergroup-autoscalingpolicy): 
    AutoScalingPolicy
  [BalancingStrategy](#cfn-gamelift-gameservergroup-balancingstrategy): String
  [DeleteOption](#cfn-gamelift-gameservergroup-deleteoption): String
  [GameServerGroupName](#cfn-gamelift-gameservergroup-gameservergroupname): String
  [GameServerProtectionPolicy](#cfn-gamelift-gameservergroup-gameserverprotectionpolicy): String
  [InstanceDefinitions](#cfn-gamelift-gameservergroup-instancedefinitions): 
    - InstanceDefinition
  [LaunchTemplate](#cfn-gamelift-gameservergroup-launchtemplate): 
    LaunchTemplate
  [MaxSize](#cfn-gamelift-gameservergroup-maxsize): Number
  [MinSize](#cfn-gamelift-gameservergroup-minsize): Number
  [RoleArn](#cfn-gamelift-gameservergroup-rolearn): String
  [Tags](#cfn-gamelift-gameservergroup-tags): 
    - Tag
  [VpcSubnets](#cfn-gamelift-gameservergroup-vpcsubnets): 
    - String
```

## Properties
<a name="aws-resource-gamelift-gameservergroup-properties"></a>

`AutoScalingPolicy`  <a name="cfn-gamelift-gameservergroup-autoscalingpolicy"></a>
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.  
*Required*: No  
*Type*: [AutoScalingPolicy](aws-properties-gamelift-gameservergroup-autoscalingpolicy.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BalancingStrategy`  <a name="cfn-gamelift-gameservergroup-balancingstrategy"></a>
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.
*Required*: No  
*Type*: String  
*Allowed values*: `SPOT_ONLY | SPOT_PREFERRED | ON_DEMAND_ONLY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DeleteOption`  <a name="cfn-gamelift-gameservergroup-deleteoption"></a>
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.
*Required*: No  
*Type*: String  
*Allowed values*: `SAFE_DELETE | FORCE_DELETE | RETAIN`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GameServerGroupName`  <a name="cfn-gamelift-gameservergroup-gameservergroupname"></a>
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z0-9-\.]+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GameServerProtectionPolicy`  <a name="cfn-gamelift-gameservergroup-gameserverprotectionpolicy"></a>
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.   
*Required*: No  
*Type*: String  
*Allowed values*: `NO_PROTECTION | FULL_PROTECTION`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InstanceDefinitions`  <a name="cfn-gamelift-gameservergroup-instancedefinitions"></a>
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.   
*Required*: Yes  
*Type*: Array of [InstanceDefinition](aws-properties-gamelift-gameservergroup-instancedefinition.md)  
*Minimum*: `2`  
*Maximum*: `20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LaunchTemplate`  <a name="cfn-gamelift-gameservergroup-launchtemplate"></a>
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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) 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.
*Required*: No  
*Type*: [LaunchTemplate](aws-properties-gamelift-gameservergroup-launchtemplate.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxSize`  <a name="cfn-gamelift-gameservergroup-maxsize"></a>
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.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinSize`  <a name="cfn-gamelift-gameservergroup-minsize"></a>
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.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-gamelift-gameservergroup-rolearn"></a>
The Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:.*:role\/[\w+=,.@-]+`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-gamelift-gameservergroup-tags"></a>
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](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) 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.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-gamelift-gameservergroup-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcSubnets`  <a name="cfn-gamelift-gameservergroup-vpcsubnets"></a>
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.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `15 | 1`  
*Maximum*: `24 | 20`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-gamelift-gameservergroup-return-values"></a>

### Ref
<a name="aws-resource-gamelift-gameservergroup-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-gamelift-gameservergroup-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-gamelift-gameservergroup-return-values-fn--getatt-fn--getatt"></a>

`AutoScalingGroupArn`  <a name="AutoScalingGroupArn-fn::getatt"></a>
A unique identifier for the auto scaling group.

`GameServerGroupArn`  <a name="GameServerGroupArn-fn::getatt"></a>
A unique identifier for the game server group.

# AWS::GameLift::GameServerGroup AutoScalingPolicy
<a name="aws-properties-gamelift-gameservergroup-autoscalingpolicy"></a>

 **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. 

## Syntax
<a name="aws-properties-gamelift-gameservergroup-autoscalingpolicy-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-gamelift-gameservergroup-autoscalingpolicy-syntax.json"></a>

```
{
  "[EstimatedInstanceWarmup](#cfn-gamelift-gameservergroup-autoscalingpolicy-estimatedinstancewarmup)" : Number,
  "[TargetTrackingConfiguration](#cfn-gamelift-gameservergroup-autoscalingpolicy-targettrackingconfiguration)" : TargetTrackingConfiguration
}
```

### YAML
<a name="aws-properties-gamelift-gameservergroup-autoscalingpolicy-syntax.yaml"></a>

```
  [EstimatedInstanceWarmup](#cfn-gamelift-gameservergroup-autoscalingpolicy-estimatedinstancewarmup): Number
  [TargetTrackingConfiguration](#cfn-gamelift-gameservergroup-autoscalingpolicy-targettrackingconfiguration): 
    TargetTrackingConfiguration
```

## Properties
<a name="aws-properties-gamelift-gameservergroup-autoscalingpolicy-properties"></a>

`EstimatedInstanceWarmup`  <a name="cfn-gamelift-gameservergroup-autoscalingpolicy-estimatedinstancewarmup"></a>
Length of time, in seconds, it takes for a new instance to start new game server processes and register with Amazon GameLift Servers 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.   
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetTrackingConfiguration`  <a name="cfn-gamelift-gameservergroup-autoscalingpolicy-targettrackingconfiguration"></a>
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.  
*Required*: Yes  
*Type*: [TargetTrackingConfiguration](aws-properties-gamelift-gameservergroup-targettrackingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::GameLift::GameServerGroup InstanceDefinition
<a name="aws-properties-gamelift-gameservergroup-instancedefinition"></a>

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

An allowed instance type for a `GameServerGroup`. All game server groups must have at least two instance types defined for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.

## Syntax
<a name="aws-properties-gamelift-gameservergroup-instancedefinition-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-gamelift-gameservergroup-instancedefinition-syntax.json"></a>

```
{
  "[InstanceType](#cfn-gamelift-gameservergroup-instancedefinition-instancetype)" : String,
  "[WeightedCapacity](#cfn-gamelift-gameservergroup-instancedefinition-weightedcapacity)" : String
}
```

### YAML
<a name="aws-properties-gamelift-gameservergroup-instancedefinition-syntax.yaml"></a>

```
  [InstanceType](#cfn-gamelift-gameservergroup-instancedefinition-instancetype): String
  [WeightedCapacity](#cfn-gamelift-gameservergroup-instancedefinition-weightedcapacity): String
```

## Properties
<a name="aws-properties-gamelift-gameservergroup-instancedefinition-properties"></a>

`InstanceType`  <a name="cfn-gamelift-gameservergroup-instancedefinition-instancetype"></a>
An Amazon EC2 instance type designation.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WeightedCapacity`  <a name="cfn-gamelift-gameservergroup-instancedefinition-weightedcapacity"></a>
Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift Servers FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see [Instance Weighting](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html) in the *Amazon Elastic Compute Cloud Auto Scaling User Guide*. Default value is "1".  
*Required*: No  
*Type*: String  
*Pattern*: `^[\u0031-\u0039][\u0030-\u0039]{0,2}$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::GameLift::GameServerGroup LaunchTemplate
<a name="aws-properties-gamelift-gameservergroup-launchtemplate"></a>

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

An Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in a game server group. The launch template is specified when creating a new game server group with `GameServerGroup`. 

## Syntax
<a name="aws-properties-gamelift-gameservergroup-launchtemplate-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-gamelift-gameservergroup-launchtemplate-syntax.json"></a>

```
{
  "[LaunchTemplateId](#cfn-gamelift-gameservergroup-launchtemplate-launchtemplateid)" : String,
  "[LaunchTemplateName](#cfn-gamelift-gameservergroup-launchtemplate-launchtemplatename)" : String,
  "[Version](#cfn-gamelift-gameservergroup-launchtemplate-version)" : String
}
```

### YAML
<a name="aws-properties-gamelift-gameservergroup-launchtemplate-syntax.yaml"></a>

```
  [LaunchTemplateId](#cfn-gamelift-gameservergroup-launchtemplate-launchtemplateid): String
  [LaunchTemplateName](#cfn-gamelift-gameservergroup-launchtemplate-launchtemplatename): String
  [Version](#cfn-gamelift-gameservergroup-launchtemplate-version): String
```

## Properties
<a name="aws-properties-gamelift-gameservergroup-launchtemplate-properties"></a>

`LaunchTemplateId`  <a name="cfn-gamelift-gameservergroup-launchtemplate-launchtemplateid"></a>
A unique identifier for an existing Amazon EC2 launch template.  
*Required*: No  
*Type*: String  
*Pattern*: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]+`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LaunchTemplateName`  <a name="cfn-gamelift-gameservergroup-launchtemplate-launchtemplatename"></a>
A readable identifier for an existing Amazon EC2 launch template.   
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9\(\)\.\-/_]+`  
*Minimum*: `3`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Version`  <a name="cfn-gamelift-gameservergroup-launchtemplate-version"></a>
The version of the Amazon EC2 launch template to use. If no version is specified, the default version will be used. With Amazon EC2, you can specify a default version for a launch template. If none is set, the default is the first version created.  
*Required*: No  
*Type*: String  
*Pattern*: `[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::GameLift::GameServerGroup Tag
<a name="aws-properties-gamelift-gameservergroup-tag"></a>

A label that you can assign to a Amazon GameLift Servers resource. 

 **Learn more** 

[Tagging AWS Resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *AWS General Reference*

 [AWS Tagging Strategies](https://aws.amazon.com/answers/account-management/aws-tagging-strategies/) 

 **Related actions** 

 [All APIs by task](https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets) 

## Syntax
<a name="aws-properties-gamelift-gameservergroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-gamelift-gameservergroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-gamelift-gameservergroup-tag-key)" : String,
  "[Value](#cfn-gamelift-gameservergroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-gamelift-gameservergroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-gamelift-gameservergroup-tag-key): String
  [Value](#cfn-gamelift-gameservergroup-tag-value): String
```

## Properties
<a name="aws-properties-gamelift-gameservergroup-tag-properties"></a>

`Key`  <a name="cfn-gamelift-gameservergroup-tag-key"></a>
The key for a developer-defined key value pair for tagging an AWS resource.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-gamelift-gameservergroup-tag-value"></a>
The value for a developer-defined key value pair for tagging an AWS resource.   
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::GameLift::GameServerGroup TargetTrackingConfiguration
<a name="aws-properties-gamelift-gameservergroup-targettrackingconfiguration"></a>

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

Settings for a target-based scaling policy as part of a `GameServerGroupAutoScalingPolicy`. 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. 

## Syntax
<a name="aws-properties-gamelift-gameservergroup-targettrackingconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-gamelift-gameservergroup-targettrackingconfiguration-syntax.json"></a>

```
{
  "[TargetValue](#cfn-gamelift-gameservergroup-targettrackingconfiguration-targetvalue)" : Number
}
```

### YAML
<a name="aws-properties-gamelift-gameservergroup-targettrackingconfiguration-syntax.yaml"></a>

```
  [TargetValue](#cfn-gamelift-gameservergroup-targettrackingconfiguration-targetvalue): Number
```

## Properties
<a name="aws-properties-gamelift-gameservergroup-targettrackingconfiguration-properties"></a>

`TargetValue`  <a name="cfn-gamelift-gameservergroup-targettrackingconfiguration-targetvalue"></a>
Desired value to use with a game server group target-based scaling policy.   
*Required*: Yes  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)