amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.Types.DesiredPlayerSession

Description

 
Synopsis

Documentation

data DesiredPlayerSession Source #

Player information for use when creating player sessions using a game session placement request.

See: newDesiredPlayerSession smart constructor.

Constructors

DesiredPlayerSession' 

Fields

  • playerData :: Maybe Text

    Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

  • playerId :: Maybe Text

    A unique identifier for a player to associate with the player session.

Instances

Instances details
ToJSON DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Generic DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Associated Types

type Rep DesiredPlayerSession :: Type -> Type #

Read DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Show DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

NFData DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Methods

rnf :: DesiredPlayerSession -> () #

Eq DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Hashable DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

type Rep DesiredPlayerSession Source # 
Instance details

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

type Rep DesiredPlayerSession = D1 ('MetaData "DesiredPlayerSession" "Amazonka.GameLift.Types.DesiredPlayerSession" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DesiredPlayerSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "playerData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "playerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDesiredPlayerSession :: DesiredPlayerSession Source #

Create a value of DesiredPlayerSession 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:playerData:DesiredPlayerSession', desiredPlayerSession_playerData - Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

$sel:playerId:DesiredPlayerSession', desiredPlayerSession_playerId - A unique identifier for a player to associate with the player session.

desiredPlayerSession_playerData :: Lens' DesiredPlayerSession (Maybe Text) Source #

Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.

desiredPlayerSession_playerId :: Lens' DesiredPlayerSession (Maybe Text) Source #

A unique identifier for a player to associate with the player session.