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

Amazonka.GameLift.UpdateGameServerGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

__This operation is used with the GameLift FleetIQ solution and game server groups.__

Updates GameLift FleetIQ-specific properties for a game server group. Many Auto Scaling group properties are updated on the Auto Scaling group directly, including the launch template, Auto Scaling policies, and maximum/minimum/desired instance counts.

To update the game server group, specify the game server group ID and provide the updated values. Before applying the updates, the new values are validated to ensure that GameLift FleetIQ can continue to perform instance balancing activity. If successful, a GameServerGroup object is returned.

Learn more

GameLift FleetIQ Guide

Synopsis

Creating a Request

data UpdateGameServerGroup Source #

See: newUpdateGameServerGroup smart constructor.

Constructors

UpdateGameServerGroup'

Fields

balancingStrategy :: Maybe 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.
gameServerProtectionPolicy :: Maybe 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.
instanceDefinitions :: Maybe (NonEmpty InstanceDefinition)
An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 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.
roleArn :: Maybe Text
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
gameServerGroupName :: Text
A unique identifier for the game server group. Use either the name or ARN value.

Instances

Instances details

ToJSON UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods toJSON :: UpdateGameServerGroup -> Value # toEncoding :: UpdateGameServerGroup -> Encoding # toJSONList :: [UpdateGameServerGroup] -> Value # toEncodingList :: [UpdateGameServerGroup] -> Encoding #
ToHeaders UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods toHeaders :: UpdateGameServerGroup -> [Header] #
ToPath UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods toPath :: UpdateGameServerGroup -> ByteString #
ToQuery UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods toQuery :: UpdateGameServerGroup -> QueryString #
AWSRequest UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Associated Types type AWSResponse UpdateGameServerGroup # Methods request :: (Service -> Service) -> UpdateGameServerGroup -> Request UpdateGameServerGroup # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGameServerGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGameServerGroup))) #
Generic UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Associated Types type Rep UpdateGameServerGroup :: Type -> Type # Methods from :: UpdateGameServerGroup -> Rep UpdateGameServerGroup x # to :: Rep UpdateGameServerGroup x -> UpdateGameServerGroup #
Read UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods readsPrec :: Int -> ReadS UpdateGameServerGroup # readList :: ReadS [UpdateGameServerGroup] # readPrec :: ReadPrec UpdateGameServerGroup # readListPrec :: ReadPrec [UpdateGameServerGroup] #
Show UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods showsPrec :: Int -> UpdateGameServerGroup -> ShowS # show :: UpdateGameServerGroup -> String # showList :: [UpdateGameServerGroup] -> ShowS #
NFData UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods rnf :: UpdateGameServerGroup -> () #
Eq UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods (==) :: UpdateGameServerGroup -> UpdateGameServerGroup -> Bool # (/=) :: UpdateGameServerGroup -> UpdateGameServerGroup -> Bool #
Hashable UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods hashWithSalt :: Int -> UpdateGameServerGroup -> Int # hash :: UpdateGameServerGroup -> Int #
type AWSResponse UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup type AWSResponse UpdateGameServerGroup = UpdateGameServerGroupResponse
type Rep UpdateGameServerGroup Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup type Rep UpdateGameServerGroup = D1 ('MetaData "UpdateGameServerGroup" "Amazonka.GameLift.UpdateGameServerGroup" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateGameServerGroup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "balancingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BalancingStrategy)) :: S1 ('MetaSel ('Just "gameServerProtectionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameServerProtectionPolicy))) :: (S1 ('MetaSel ('Just "instanceDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty InstanceDefinition))) :: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gameServerGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateGameServerGroup Source #

Arguments

:: Text	`UpdateGameServerGroup`
-> UpdateGameServerGroup

Create a value of UpdateGameServerGroup 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:

UpdateGameServerGroup, updateGameServerGroup_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.

UpdateGameServerGroup, updateGameServerGroup_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.

UpdateGameServerGroup, updateGameServerGroup_instanceDefinitions - An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 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.

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

UpdateGameServerGroup, updateGameServerGroup_gameServerGroupName - A unique identifier for the game server group. Use either the name or ARN value.

Request Lenses

updateGameServerGroup_balancingStrategy :: Lens' UpdateGameServerGroup (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.

updateGameServerGroup_gameServerProtectionPolicy :: Lens' UpdateGameServerGroup (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.

updateGameServerGroup_instanceDefinitions :: Lens' UpdateGameServerGroup (Maybe (NonEmpty InstanceDefinition)) Source #

An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 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.

updateGameServerGroup_roleArn :: Lens' UpdateGameServerGroup (Maybe Text) Source #

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

updateGameServerGroup_gameServerGroupName :: Lens' UpdateGameServerGroup Text Source #

A unique identifier for the game server group. Use either the name or ARN value.

Destructuring the Response

data UpdateGameServerGroupResponse Source #

See: newUpdateGameServerGroupResponse smart constructor.

Constructors

UpdateGameServerGroupResponse'
Fields gameServerGroup :: Maybe GameServerGroup An object that describes the game server group resource with updated properties. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateGameServerGroupResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Associated Types type Rep UpdateGameServerGroupResponse :: Type -> Type # Methods from :: UpdateGameServerGroupResponse -> Rep UpdateGameServerGroupResponse x # to :: Rep UpdateGameServerGroupResponse x -> UpdateGameServerGroupResponse #
Read UpdateGameServerGroupResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods readsPrec :: Int -> ReadS UpdateGameServerGroupResponse # readList :: ReadS [UpdateGameServerGroupResponse] # readPrec :: ReadPrec UpdateGameServerGroupResponse # readListPrec :: ReadPrec [UpdateGameServerGroupResponse] #
Show UpdateGameServerGroupResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods showsPrec :: Int -> UpdateGameServerGroupResponse -> ShowS # show :: UpdateGameServerGroupResponse -> String # showList :: [UpdateGameServerGroupResponse] -> ShowS #
NFData UpdateGameServerGroupResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods rnf :: UpdateGameServerGroupResponse -> () #
Eq UpdateGameServerGroupResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup Methods (==) :: UpdateGameServerGroupResponse -> UpdateGameServerGroupResponse -> Bool # (/=) :: UpdateGameServerGroupResponse -> UpdateGameServerGroupResponse -> Bool #
type Rep UpdateGameServerGroupResponse Source #
Instance details Defined in Amazonka.GameLift.UpdateGameServerGroup type Rep UpdateGameServerGroupResponse = D1 ('MetaData "UpdateGameServerGroupResponse" "Amazonka.GameLift.UpdateGameServerGroup" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateGameServerGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServerGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameServerGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateGameServerGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateGameServerGroupResponse'`
-> UpdateGameServerGroupResponse

Create a value of UpdateGameServerGroupResponse 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:UpdateGameServerGroupResponse', updateGameServerGroupResponse_gameServerGroup - An object that describes the game server group resource with updated properties.

$sel:httpStatus:UpdateGameServerGroupResponse', updateGameServerGroupResponse_httpStatus - The response's http status code.

Response Lenses

updateGameServerGroupResponse_gameServerGroup :: Lens' UpdateGameServerGroupResponse (Maybe GameServerGroup) Source #

An object that describes the game server group resource with updated properties.

updateGameServerGroupResponse_httpStatus :: Lens' UpdateGameServerGroupResponse Int Source #

The response's http status code.