game_server_group

Gets an individual game_server_group resource

Overview

Name	game_server_group
Type	Resource
Description	game_server_group
Id	awscc.gamelift.game_server_group

Fields

Name	Datatype	Description
auto_scaling_group_arn	string	A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
auto_scaling_policy	object	Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting
balancing_strategy	string	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.
delete_option	string	The type of delete to perform.
game_server_group_arn	string	A generated unique ID for the game server group.
game_server_group_name	string	An identifier for the new game server group.
game_server_protection_policy	string	A flag that indicates whether instances in the game server group are protected from early termination.
instance_definitions	array	A set of EC2 instance types to use when creating instances in the group.
launch_template	object	The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
max_size	number	The maximum number of instances allowed in the EC2 Auto Scaling group.
min_size	number	The minimum number of instances allowed in the EC2 Auto Scaling group.
role_arn	string	The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
tags	array	A list of labels to assign to the new game server group resource.
vpc_subnets	array	A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
auto_scaling_group_arn,
auto_scaling_policy,
balancing_strategy,
delete_option,
game_server_group_arn,
game_server_group_name,
game_server_protection_policy,
instance_definitions,
launch_template,
max_size,
min_size,
role_arn,
tags,
vpc_subnets
FROM awscc.gamelift.game_server_group
WHERE data__Identifier = '<GameServerGroupArn>';

Permissions

To operate on the game_server_group resource, the following permissions are required:

Read

gamelift:DescribeGameServerGroup

Update

gamelift:UpdateGameServerGroup,
iam:assumeRole,
iam:PassRole,
autoscaling:DescribeAutoScalingGroups,
autoscaling:UpdateAutoScalingGroup,
autoscaling:SetInstanceProtection

Delete

gamelift:DeleteGameServerGroup,
gamelift:DescribeGameServerGroup,
iam:assumeRole,
iam:PassRole,
iam:CreateServiceLinkedRole,
ec2:DescribeAvailabilityZones,
ec2:DescribeSubnets,
ec2:DescribeLaunchTemplateVersions,
autoscaling:CreateAutoScalingGroup,
autoscaling:DescribeLifecycleHooks,
autoscaling:DescribeNotificationConfigurations,
autoscaling:DescribeAutoScalingGroups,
autoscaling:ExitStandby,
autoscaling:PutLifecycleHook,
autoscaling:PutScalingPolicy,
autoscaling:ResumeProcesses,
autoscaling:SetInstanceProtection,
autoscaling:UpdateAutoScalingGroup,
autoscaling:DeleteAutoScalingGroup,
events:PutRule,
events:PutTargets