class CfnGameServerGroup (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.GameLift.CfnGameServerGroup`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnGameServerGroup`
Java	`software.amazon.awscdk.services.gamelift.CfnGameServerGroup`
Python	`aws_cdk.aws_gamelift.CfnGameServerGroup`
TypeScript	`aws-cdk-lib` » `aws_gamelift` » `CfnGameServerGroup`

Implements IConstruct, IDependable, IInspectable, ITaggable

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_gamelift as gamelift } from 'aws-cdk-lib';
const cfnGameServerGroup = new gamelift.CfnGameServerGroup(this, 'MyCfnGameServerGroup', {
  gameServerGroupName: 'gameServerGroupName',
  instanceDefinitions: [{
    instanceType: 'instanceType',

    // the properties below are optional
    weightedCapacity: 'weightedCapacity',
  }],
  roleArn: 'roleArn',

  // the properties below are optional
  autoScalingPolicy: {
    targetTrackingConfiguration: {
      targetValue: 123,
    },

    // the properties below are optional
    estimatedInstanceWarmup: 123,
  },
  balancingStrategy: 'balancingStrategy',
  deleteOption: 'deleteOption',
  gameServerProtectionPolicy: 'gameServerProtectionPolicy',
  launchTemplate: {
    launchTemplateId: 'launchTemplateId',
    launchTemplateName: 'launchTemplateName',
    version: 'version',
  },
  maxSize: 123,
  minSize: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcSubnets: ['vpcSubnets'],
});

Initializer

new CfnGameServerGroup(scope: Construct, id: string, props: CfnGameServerGroupProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnGameServerGroupProps — Resource properties.

Construct Props

Name	Type	Description
gameServerGroupName	`string`	A developer-defined identifier for the game server group.
instanceDefinitions	`IResolvable` `\|` `IResolvable` `\|` `InstanceDefinitionProperty[]`	The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
roleArn	`string`	The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
autoScalingPolicy?	`IResolvable` `\|` `AutoScalingPolicyProperty`	Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
balancingStrategy?	`string`	Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
deleteOption?	`string`	The type of delete to perform.
gameServerProtectionPolicy?	`string`	A flag that indicates whether instances in the game server group are protected from early termination.
launchTemplate?	`IResolvable` `\|` `LaunchTemplateProperty`	The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
maxSize?	`number`	The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
minSize?	`number`	The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
tags?	`CfnTag[]`	A list of labels to assign to the new game server group resource.
vpcSubnets?	`string[]`	A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

gameServerGroupName

Type: string

A developer-defined identifier for the game server group.

The name is unique for each Region in each AWS account.

instanceDefinitions

Type: IResolvable | IResolvable | InstanceDefinitionProperty[]

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

roleArn

Type: string

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

autoScalingPolicy?

Type: IResolvable | AutoScalingPolicyProperty (optional)

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.

balancingStrategy?

Type: string (optional)

Indicates how Amazon GameLift 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.

deleteOption?

Type: string (optional)

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.

gameServerProtectionPolicy?

Type: string (optional)

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.

launchTemplate?

Type: IResolvable | LaunchTemplateProperty (optional)

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 FleetIQ uses your account's default VPC.

maxSize?

Type: number (optional)

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

During automatic scaling events, Amazon GameLift 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.

minSize?

Type: number (optional)

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

During automatic scaling events, Amazon GameLift 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.

tags?

Type: CfnTag[] (optional)

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.

vpcSubnets?

Type: string[] (optional)

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

By default, all Amazon GameLift 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.

Properties

Name	Type	Description
attrAutoScalingGroupArn	`string`	A unique identifier for the auto scaling group.
attrGameServerGroupArn	`string`	A unique identifier for the game server group.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
gameServerGroupName	`string`	A developer-defined identifier for the game server group.
instanceDefinitions	`IResolvable` `\|` `IResolvable` `\|` `InstanceDefinitionProperty[]`	The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
roleArn	`string`	The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
autoScalingPolicy?	`IResolvable` `\|` `AutoScalingPolicyProperty`	Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
balancingStrategy?	`string`	Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
deleteOption?	`string`	The type of delete to perform.
gameServerProtectionPolicy?	`string`	A flag that indicates whether instances in the game server group are protected from early termination.
launchTemplate?	`IResolvable` `\|` `LaunchTemplateProperty`	The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
maxSize?	`number`	The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
minSize?	`number`	The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
tagsRaw?	`CfnTag[]`	A list of labels to assign to the new game server group resource.
vpcSubnets?	`string[]`	A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrAutoScalingGroupArn

Type: string

A unique identifier for the auto scaling group.

attrGameServerGroupArn

Type: string

A unique identifier for the game server group.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

gameServerGroupName

Type: string

A developer-defined identifier for the game server group.

instanceDefinitions

Type: IResolvable | IResolvable | InstanceDefinitionProperty[]

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

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

roleArn

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

autoScalingPolicy?

Type: IResolvable | AutoScalingPolicyProperty (optional)

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

balancingStrategy?

Type: string (optional)

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

deleteOption?

Type: string (optional)

The type of delete to perform.

gameServerProtectionPolicy?

Type: string (optional)

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

launchTemplate?

Type: IResolvable | LaunchTemplateProperty (optional)

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

maxSize?

Type: number (optional)

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

minSize?

Type: number (optional)

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

tagsRaw?

Type: CfnTag[] (optional)

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

vpcSubnets?

Type: string[] (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }