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

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

Terminates a game server group and permanently deletes the game server group record. You have several options for how these resources are impacted when deleting the game server group. Depending on the type of delete operation selected, this operation might affect these resources:

The game server group
The corresponding Auto Scaling group
All game servers that are currently running in the group

To delete a game server group, identify the game server group to delete and specify the type of delete operation to initiate. Game server groups can only be deleted if they are in ACTIVE or ERROR status.

If the delete request is successful, a series of operations are kicked off. The game server group status is changed to DELETE_SCHEDULED, which prevents new game servers from being registered and stops automatic scaling activity. Once all game servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources. If any of the delete operations fail, the game server group is placed in ERROR status.

GameLift FleetIQ emits delete events to Amazon CloudWatch.

Learn more

GameLift FleetIQ Guide

Creating a Request

data DeleteGameServerGroup Source #

See: newDeleteGameServerGroup smart constructor.

Constructors

DeleteGameServerGroup'

Fields

deleteOption :: Maybe GameServerGroupDeleteOption
The type of delete to perform. 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.
gameServerGroupName :: Text
A unique identifier for the game server group. Use either the name or ARN value.

Instances

Instances details

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

newDeleteGameServerGroup Source #

Arguments

:: Text	`DeleteGameServerGroup`
-> DeleteGameServerGroup

Create a value of DeleteGameServerGroup 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:deleteOption:DeleteGameServerGroup', deleteGameServerGroup_deleteOption - The type of delete to perform. 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.

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

Request Lenses

deleteGameServerGroup_deleteOption :: Lens' DeleteGameServerGroup (Maybe GameServerGroupDeleteOption) Source #

The type of delete to perform. 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.

deleteGameServerGroup_gameServerGroupName :: Lens' DeleteGameServerGroup Text Source #

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

Destructuring the Response

data DeleteGameServerGroupResponse Source #

See: newDeleteGameServerGroupResponse smart constructor.

Constructors

DeleteGameServerGroupResponse'
Fields gameServerGroup :: Maybe GameServerGroup An object that describes the deleted game server group resource, with status updated to `DELETE_SCHEDULED`. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDeleteGameServerGroupResponse Source #

Arguments

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

Create a value of DeleteGameServerGroupResponse 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:DeleteGameServerGroupResponse', deleteGameServerGroupResponse_gameServerGroup - An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED.

$sel:httpStatus:DeleteGameServerGroupResponse', deleteGameServerGroupResponse_httpStatus - The response's http status code.

Response Lenses

deleteGameServerGroupResponse_gameServerGroup :: Lens' DeleteGameServerGroupResponse (Maybe GameServerGroup) Source #

An object that describes the deleted game server group resource, with status updated to DELETE_SCHEDULED.

deleteGameServerGroupResponse_httpStatus :: Lens' DeleteGameServerGroupResponse Int Source #

The response's http status code.