libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.RegisterGameServer

Description

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

Creates a new game server resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data. When a game client or service requests a game server by calling ClaimGameServer, this information is returned in the response.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

GameLift FleetIQ Guide

Related actions

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Synopsis

Creating a Request

data RegisterGameServer Source #

See: newRegisterGameServer smart constructor.

Constructors

RegisterGameServer' 

Fields

  • gameServerData :: Maybe Text

    A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

  • connectionInfo :: Maybe Text

    Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

  • gameServerGroupName :: Text

    A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

  • gameServerId :: Text

    A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

  • instanceId :: Text

    The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Instances

Instances details
Eq RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

(==) :: RegisterGameServer -> RegisterGameServer -> Bool #

(/=) :: RegisterGameServer -> RegisterGameServer -> Bool #

Read RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

readsPrec :: Int -> ReadS RegisterGameServer #

readList :: ReadS [RegisterGameServer] #

readPrec :: ReadPrec RegisterGameServer #

readListPrec :: ReadPrec [RegisterGameServer] #

Show RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

showsPrec :: Int -> RegisterGameServer -> ShowS #

show :: RegisterGameServer -> String #

showList :: [RegisterGameServer] -> ShowS #

Generic RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Associated Types

type Rep RegisterGameServer :: Type -> Type #

Methods

from :: RegisterGameServer -> Rep RegisterGameServer x #

to :: Rep RegisterGameServer x -> RegisterGameServer #

NFData RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

rnf :: RegisterGameServer -> () #

Hashable RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

hashWithSalt :: Int -> RegisterGameServer -> Int #

hash :: RegisterGameServer -> Int #

ToJSON RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

toJSON :: RegisterGameServer -> Value #

toEncoding :: RegisterGameServer -> Encoding #

toJSONList :: [RegisterGameServer] -> Value #

toEncodingList :: [RegisterGameServer] -> Encoding #

AWSRequest RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Associated Types

type AWSResponse RegisterGameServer #

Methods

request :: RegisterGameServer -> Request RegisterGameServer #

response :: MonadResource m => Logger -> Service -> Proxy RegisterGameServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterGameServer))) #

ToHeaders RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

toHeaders :: RegisterGameServer -> [Header] #

ToPath RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

toPath :: RegisterGameServer -> ByteString #

ToQuery RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

toQuery :: RegisterGameServer -> QueryString #

type Rep RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

type Rep RegisterGameServer = D1 ('MetaData "RegisterGameServer" "Amazonka.GameLift.RegisterGameServer" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "RegisterGameServer'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "gameServerData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "connectionInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "gameServerGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "gameServerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse RegisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

type AWSResponse RegisterGameServer = RegisterGameServerResponse

newRegisterGameServer Source #

Arguments

:: Text

$sel:gameServerGroupName:RegisterGameServer'

-> Text

$sel:gameServerId:RegisterGameServer'

-> Text

$sel:instanceId:RegisterGameServer'

-> RegisterGameServer 

Create a value of RegisterGameServer 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:gameServerData:RegisterGameServer', registerGameServer_gameServerData - A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

$sel:connectionInfo:RegisterGameServer', registerGameServer_connectionInfo - Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

$sel:gameServerGroupName:RegisterGameServer', registerGameServer_gameServerGroupName - A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

$sel:gameServerId:RegisterGameServer', registerGameServer_gameServerId - A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

$sel:instanceId:RegisterGameServer', registerGameServer_instanceId - The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Request Lenses

registerGameServer_gameServerData :: Lens' RegisterGameServer (Maybe Text) Source #

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

registerGameServer_connectionInfo :: Lens' RegisterGameServer (Maybe Text) Source #

Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

registerGameServer_gameServerGroupName :: Lens' RegisterGameServer Text Source #

A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

registerGameServer_gameServerId :: Lens' RegisterGameServer Text Source #

A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

registerGameServer_instanceId :: Lens' RegisterGameServer Text Source #

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Destructuring the Response

data RegisterGameServerResponse Source #

See: newRegisterGameServerResponse smart constructor.

Constructors

RegisterGameServerResponse' 

Fields

Instances

Instances details
Eq RegisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

(==) :: RegisterGameServerResponse -> RegisterGameServerResponse -> Bool #

(/=) :: RegisterGameServerResponse -> RegisterGameServerResponse -> Bool #

Read RegisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

readsPrec :: Int -> ReadS RegisterGameServerResponse #

readList :: ReadS [RegisterGameServerResponse] #

readPrec :: ReadPrec RegisterGameServerResponse #

readListPrec :: ReadPrec [RegisterGameServerResponse] #

Show RegisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

showsPrec :: Int -> RegisterGameServerResponse -> ShowS #

show :: RegisterGameServerResponse -> String #

showList :: [RegisterGameServerResponse] -> ShowS #

Generic RegisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Associated Types

type Rep RegisterGameServerResponse :: Type -> Type #

Methods

from :: RegisterGameServerResponse -> Rep RegisterGameServerResponse x #

to :: Rep RegisterGameServerResponse x -> RegisterGameServerResponse #

NFData RegisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

Methods

rnf :: RegisterGameServerResponse -> () #

type Rep RegisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.RegisterGameServer

type Rep RegisterGameServerResponse = D1 ('MetaData "RegisterGameServerResponse" "Amazonka.GameLift.RegisterGameServer" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "RegisterGameServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameServer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterGameServerResponse Source #

Arguments

:: Int

$sel:httpStatus:RegisterGameServerResponse'

-> RegisterGameServerResponse 

Create a value of RegisterGameServerResponse 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:gameServer:RegisterGameServerResponse', registerGameServerResponse_gameServer - Object that describes the newly registered game server.

$sel:httpStatus:RegisterGameServerResponse', registerGameServerResponse_httpStatus - The response's http status code.

Response Lenses

registerGameServerResponse_gameServer :: Lens' RegisterGameServerResponse (Maybe GameServer) Source #

Object that describes the newly registered game server.

registerGameServerResponse_httpStatus :: Lens' RegisterGameServerResponse Int Source #

The response's http status code.