Amazonka.GameLift.Types.DesiredPlayerSession

Documentation

data DesiredPlayerSession

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

ToJSON DesiredPlayerSession

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Methods

toJSON :: DesiredPlayerSession -> Value

toEncoding :: DesiredPlayerSession -> Encoding

toJSONList :: [DesiredPlayerSession] -> Value

toEncodingList :: [DesiredPlayerSession] -> Encoding

Generic DesiredPlayerSession

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Associated Types

type Rep DesiredPlayerSession :: Type -> Type

Methods

from :: DesiredPlayerSession -> Rep DesiredPlayerSession x

to :: Rep DesiredPlayerSession x -> DesiredPlayerSession

Read DesiredPlayerSession

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Methods

readsPrec :: Int -> ReadS DesiredPlayerSession

readList :: ReadS [DesiredPlayerSession]

readPrec :: ReadPrec DesiredPlayerSession

readListPrec :: ReadPrec [DesiredPlayerSession]

Show DesiredPlayerSession

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Methods

showsPrec :: Int -> DesiredPlayerSession -> ShowS

show :: DesiredPlayerSession -> String

showList :: [DesiredPlayerSession] -> ShowS

NFData DesiredPlayerSession

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Methods

rnf :: DesiredPlayerSession -> ()

Eq DesiredPlayerSession

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Methods

(==) :: DesiredPlayerSession -> DesiredPlayerSession -> Bool

(/=) :: DesiredPlayerSession -> DesiredPlayerSession -> Bool

Hashable DesiredPlayerSession

Defined in Amazonka.GameLift.Types.DesiredPlayerSession

Methods

hashWithSalt :: Int -> DesiredPlayerSession -> Int

hash :: DesiredPlayerSession -> Int

type Rep DesiredPlayerSession

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

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)

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)

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