Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-gamelift-gameservergroup.json
Parent schema serverless-framework-configuration
Type: object

The AWS::GameLift::GameServerGroup resource creates an Amazon GameLift (GameLift) GameServerGroup.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-gamelift.git

Properties

GameServerGroupName string | Aws_CF_FunctionString required

An identifier for the new game server group.

InstanceDefinitions InstanceDefinition[] required

A set of EC2 instance types to use when creating instances in the group.

minItems=2maxItems=20
RoleArn string | Aws_CF_FunctionString required

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

AutoScalingPolicy object

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

2 nested properties
TargetTrackingConfiguration object required

Settings for a target-based scaling policy applied to Auto Scaling group.

1 nested properties
TargetValue number required

Desired value to use with a game server group target-based scaling policy.

EstimatedInstanceWarmup number

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.

BalancingStrategy string | Aws_CF_FunctionString

The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

DeleteOption string | Aws_CF_FunctionString

The type of delete to perform.

GameServerProtectionPolicy string | Aws_CF_FunctionString

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

LaunchTemplate object

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

3 nested properties
LaunchTemplateId string | Aws_CF_FunctionString

A unique identifier for an existing EC2 launch template.

LaunchTemplateName string | Aws_CF_FunctionString

A readable identifier for an existing EC2 launch template.

Version string | Aws_CF_FunctionString

The version of the EC2 launch template to use.

MaxSize number

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

min=1
MinSize number

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

min=0
Tags Tag[]

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

minItems=0maxItems=200
VpcSubnets string[]

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

minItems=1maxItems=20

Definitions

AutoScalingPolicy object

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

TargetTrackingConfiguration object required

Settings for a target-based scaling policy applied to Auto Scaling group.

1 nested properties
TargetValue number required

Desired value to use with a game server group target-based scaling policy.

EstimatedInstanceWarmup number

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.

EstimatedInstanceWarmup number

Length of time, in seconds, it takes for a new instance to start new game server processes and register with GameLift FleetIQ.

TargetTrackingConfiguration object

Settings for a target-based scaling policy applied to Auto Scaling group.

TargetValue number required

Desired value to use with a game server group target-based scaling policy.

TargetValue number

Desired value to use with a game server group target-based scaling policy.

BalancingStrategy string | Aws_CF_FunctionString

The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

DeleteOption string | Aws_CF_FunctionString

The type of delete to perform.

GameServerGroupName string | Aws_CF_FunctionString

An identifier for the new game server group.

GameServerProtectionPolicy string | Aws_CF_FunctionString

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

GameServerGroupArn string | Aws_CF_FunctionString

A generated unique ID for the game server group.

InstanceDefinitions InstanceDefinition[]

A set of EC2 instance types to use when creating instances in the group.

InstanceDefinition object

An allowed instance type for your game server group.

InstanceType string | Aws_CF_FunctionString required

An EC2 instance type designation.

WeightedCapacity string | Aws_CF_FunctionString

Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group.

InstanceType string | Aws_CF_FunctionString

An EC2 instance type designation.

WeightedCapacity string | Aws_CF_FunctionString

Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group.

LaunchTemplate object

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

LaunchTemplateId string | Aws_CF_FunctionString

A unique identifier for an existing EC2 launch template.

LaunchTemplateName string | Aws_CF_FunctionString

A readable identifier for an existing EC2 launch template.

Version string | Aws_CF_FunctionString

The version of the EC2 launch template to use.

LaunchTemplateId string | Aws_CF_FunctionString

A unique identifier for an existing EC2 launch template.

LaunchTemplateName string | Aws_CF_FunctionString

A readable identifier for an existing EC2 launch template.

Version string | Aws_CF_FunctionString

The version of the EC2 launch template to use.

MaxSize number

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

MinSize number

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

RoleArn string | Aws_CF_FunctionString

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

Tags Tag[]

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

Tag object
Key string | Aws_CF_FunctionString

The key for a developer-defined key:value pair for tagging an AWS resource.

Value string | Aws_CF_FunctionString

The value for a developer-defined key:value pair for tagging an AWS resource.

VpcSubnets string[]

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

GameServerGroup object

Properties that describe a game server group resource. A game server group manages certain properties of a corresponding EC2 Auto Scaling group.

AutoScalingGroupArn string | Aws_CF_FunctionString

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

BalancingStrategy string | Aws_CF_FunctionString

The fallback balancing method to use for the game server group when Spot Instances in a Region become unavailable or are not viable for game hosting.

CreationTime string | Aws_CF_FunctionString

A timestamp that indicates when this data object was created.

GameServerGroupArn string | Aws_CF_FunctionString

A generated unique ID for the game server group.

GameServerGroupName string | Aws_CF_FunctionString

An identifier for the new game server group.

GameServerProtectionPolicy string | Aws_CF_FunctionString

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

InstanceDefinitions InstanceDefinition[]

A set of EC2 instance types to use when creating instances in the group.

minItems=2maxItems=20
LastUpdatedTime string | Aws_CF_FunctionString

A timestamp that indicates when this game server group was last updated.

RoleArn string | Aws_CF_FunctionString

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

Status string | Aws_CF_FunctionString

The current status of the game server group.

StatusReason string | Aws_CF_FunctionString

Additional information about the current game server group status.

SuspendedActions string[]
AutoScalingGroupArn string | Aws_CF_FunctionString

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

CreationTime string | Aws_CF_FunctionString

A timestamp that indicates when this data object was created.

LastUpdatedTime string | Aws_CF_FunctionString

A timestamp that indicates when this game server group was last updated.

Status string | Aws_CF_FunctionString

The current status of the game server group.

StatusReason string | Aws_CF_FunctionString

Additional information about the current game server group status.

SuspendedActions string[]