Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
__This operation is used with the GameLift FleetIQ solution and game server groups.__
Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your Amazon Web Services 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 Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon Elastic Compute Cloud User Guide.
- An IAM role that extends limited access to your Amazon Web Services 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 Elastic Compute Cloud 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
Synopsis
- data CreateGameServerGroup = CreateGameServerGroup' {
- autoScalingPolicy :: Maybe GameServerGroupAutoScalingPolicy
- balancingStrategy :: Maybe BalancingStrategy
- gameServerProtectionPolicy :: Maybe GameServerProtectionPolicy
- tags :: Maybe [Tag]
- vpcSubnets :: Maybe (NonEmpty Text)
- gameServerGroupName :: Text
- roleArn :: Text
- minSize :: Natural
- maxSize :: Natural
- launchTemplate :: LaunchTemplateSpecification
- instanceDefinitions :: NonEmpty InstanceDefinition
- newCreateGameServerGroup :: Text -> Text -> Natural -> Natural -> LaunchTemplateSpecification -> NonEmpty InstanceDefinition -> CreateGameServerGroup
- createGameServerGroup_autoScalingPolicy :: Lens' CreateGameServerGroup (Maybe GameServerGroupAutoScalingPolicy)
- createGameServerGroup_balancingStrategy :: Lens' CreateGameServerGroup (Maybe BalancingStrategy)
- createGameServerGroup_gameServerProtectionPolicy :: Lens' CreateGameServerGroup (Maybe GameServerProtectionPolicy)
- createGameServerGroup_tags :: Lens' CreateGameServerGroup (Maybe [Tag])
- createGameServerGroup_vpcSubnets :: Lens' CreateGameServerGroup (Maybe (NonEmpty Text))
- createGameServerGroup_gameServerGroupName :: Lens' CreateGameServerGroup Text
- createGameServerGroup_roleArn :: Lens' CreateGameServerGroup Text
- createGameServerGroup_minSize :: Lens' CreateGameServerGroup Natural
- createGameServerGroup_maxSize :: Lens' CreateGameServerGroup Natural
- createGameServerGroup_launchTemplate :: Lens' CreateGameServerGroup LaunchTemplateSpecification
- createGameServerGroup_instanceDefinitions :: Lens' CreateGameServerGroup (NonEmpty InstanceDefinition)
- data CreateGameServerGroupResponse = CreateGameServerGroupResponse' {}
- newCreateGameServerGroupResponse :: Int -> CreateGameServerGroupResponse
- createGameServerGroupResponse_gameServerGroup :: Lens' CreateGameServerGroupResponse (Maybe GameServerGroup)
- createGameServerGroupResponse_httpStatus :: Lens' CreateGameServerGroupResponse Int
Creating a Request
data CreateGameServerGroup Source #
See: newCreateGameServerGroup
smart constructor.
CreateGameServerGroup' | |
|
Instances
newCreateGameServerGroup Source #
:: Text | |
-> Text | |
-> Natural | |
-> Natural | |
-> LaunchTemplateSpecification | |
-> NonEmpty InstanceDefinition | |
-> CreateGameServerGroup |
Create a value of CreateGameServerGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoScalingPolicy:CreateGameServerGroup'
, createGameServerGroup_autoScalingPolicy
- 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 Amazon Web Services console or APIs.
CreateGameServerGroup
, createGameServerGroup_balancingStrategy
- Indicates how 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.
CreateGameServerGroup
, createGameServerGroup_gameServerProtectionPolicy
- 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 Amazon Web
Services regardless of protection status. This property is set to
NO_PROTECTION
by default.
$sel:tags:CreateGameServerGroup'
, createGameServerGroup_tags
- A list of labels to assign to the new game server group resource. Tags
are developer-defined key-value pairs. Tagging Amazon Web Services
resources is useful for resource management, access management, and cost
allocation. For more information, see
Tagging Amazon Web Services Resources
in the Amazon Web Services General Reference.
$sel:vpcSubnets:CreateGameServerGroup'
, createGameServerGroup_vpcSubnets
- A list of virtual private cloud (VPC) subnets to use with instances in
the game server group. By default, all 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.
CreateGameServerGroup
, createGameServerGroup_gameServerGroupName
- An identifier for the new game server group. This value is used to
generate unique ARN identifiers for the Amazon EC2 Auto Scaling group
and the GameLift FleetIQ game server group. The name must be unique per
Region per Amazon Web Services account.
CreateGameServerGroup
, createGameServerGroup_roleArn
- The Amazon Resource Name
(ARN)
for an IAM role that allows Amazon GameLift to access your Amazon EC2
Auto Scaling groups.
$sel:minSize:CreateGameServerGroup'
, createGameServerGroup_minSize
- The minimum number of instances allowed in the Amazon EC2 Auto Scaling
group. During automatic scaling events, 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
Amazon Web Services console or APIs.
$sel:maxSize:CreateGameServerGroup'
, createGameServerGroup_maxSize
- The maximum number of instances allowed in the Amazon EC2 Auto Scaling
group. During automatic scaling events, 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
Amazon Web Services console or APIs.
$sel:launchTemplate:CreateGameServerGroup'
, createGameServerGroup_launchTemplate
- 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 Amazon Web Services 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, GameLift
FleetIQ uses your account's default VPC.
CreateGameServerGroup
, createGameServerGroup_instanceDefinitions
- The Amazon EC2 instance types and sizes to use in the Auto Scaling
group. The instance definitions must specify at least two different
instance types that are supported by GameLift FleetIQ. For more
information on instance types, see
EC2 Instance Types
in the Amazon Elastic Compute Cloud User Guide. You can optionally
specify capacity weighting for each instance type. If no weight value is
specified for an instance type, it is set to the default value "1".
For more information about capacity weighting, see
Instance Weighting for Amazon EC2 Auto Scaling
in the Amazon EC2 Auto Scaling User Guide.
Request Lenses
createGameServerGroup_autoScalingPolicy :: Lens' CreateGameServerGroup (Maybe GameServerGroupAutoScalingPolicy) Source #
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 Amazon Web Services console or APIs.
createGameServerGroup_balancingStrategy :: Lens' CreateGameServerGroup (Maybe BalancingStrategy) Source #
Indicates how 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.
createGameServerGroup_gameServerProtectionPolicy :: Lens' CreateGameServerGroup (Maybe GameServerProtectionPolicy) Source #
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 Amazon Web
Services regardless of protection status. This property is set to
NO_PROTECTION
by default.
createGameServerGroup_tags :: Lens' CreateGameServerGroup (Maybe [Tag]) Source #
A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
createGameServerGroup_vpcSubnets :: Lens' CreateGameServerGroup (Maybe (NonEmpty Text)) Source #
A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all 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.
createGameServerGroup_gameServerGroupName :: Lens' CreateGameServerGroup Text Source #
An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.
createGameServerGroup_roleArn :: Lens' CreateGameServerGroup Text Source #
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
createGameServerGroup_minSize :: Lens' CreateGameServerGroup Natural Source #
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, 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 Amazon Web Services console or APIs.
createGameServerGroup_maxSize :: Lens' CreateGameServerGroup Natural Source #
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, 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 Amazon Web Services console or APIs.
createGameServerGroup_launchTemplate :: Lens' CreateGameServerGroup LaunchTemplateSpecification Source #
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 Amazon Web Services 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, GameLift
FleetIQ uses your account's default VPC.
createGameServerGroup_instanceDefinitions :: Lens' CreateGameServerGroup (NonEmpty InstanceDefinition) Source #
The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon Elastic Compute Cloud User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Destructuring the Response
data CreateGameServerGroupResponse Source #
See: newCreateGameServerGroupResponse
smart constructor.
CreateGameServerGroupResponse' | |
|
Instances
newCreateGameServerGroupResponse Source #
Create a value of CreateGameServerGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:gameServerGroup:CreateGameServerGroupResponse'
, createGameServerGroupResponse_gameServerGroup
- The newly created game server group object, including the new ARN value
for the GameLift FleetIQ game server group and the object's status. The
Amazon EC2 Auto Scaling group ARN is initially null, since the group has
not yet been created. This value is added once the game server group
status reaches ACTIVE
.
$sel:httpStatus:CreateGameServerGroupResponse'
, createGameServerGroupResponse_httpStatus
- The response's http status code.
Response Lenses
createGameServerGroupResponse_gameServerGroup :: Lens' CreateGameServerGroupResponse (Maybe GameServerGroup) Source #
The newly created game server group object, including the new ARN value
for the GameLift FleetIQ game server group and the object's status. The
Amazon EC2 Auto Scaling group ARN is initially null, since the group has
not yet been created. This value is added once the game server group
status reaches ACTIVE
.
createGameServerGroupResponse_httpStatus :: Lens' CreateGameServerGroupResponse Int Source #
The response's http status code.