Amazonka.GameLift.Types.GameProperty

Documentation

data GameProperty

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the GameLift Developer Guide.

See: newGameProperty smart constructor.

Constructors

GameProperty'

Fields

• key :: Text

  The game property identifier.

• value :: Text

  The game property value.

Instances

FromJSON GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Methods

parseJSON :: Value -> Parser GameProperty

parseJSONList :: Value -> Parser [GameProperty]

ToJSON GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Methods

toJSON :: GameProperty -> Value

toEncoding :: GameProperty -> Encoding

toJSONList :: [GameProperty] -> Value

toEncodingList :: [GameProperty] -> Encoding

Generic GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Associated Types

type Rep GameProperty :: Type -> Type

Methods

from :: GameProperty -> Rep GameProperty x

to :: Rep GameProperty x -> GameProperty

Read GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Methods

readsPrec :: Int -> ReadS GameProperty

readList :: ReadS [GameProperty]

readPrec :: ReadPrec GameProperty

readListPrec :: ReadPrec [GameProperty]

Show GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Methods

showsPrec :: Int -> GameProperty -> ShowS

show :: GameProperty -> String

showList :: [GameProperty] -> ShowS

NFData GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Methods

rnf :: GameProperty -> ()

Eq GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Methods

(==) :: GameProperty -> GameProperty -> Bool

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

Hashable GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

Methods

hashWithSalt :: Int -> GameProperty -> Int

hash :: GameProperty -> Int

type Rep GameProperty

Defined in Amazonka.GameLift.Types.GameProperty

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

newGameProperty

Arguments

:: Text

$sel:key:GameProperty'

-> Text

$sel:value:GameProperty'

-> GameProperty

Create a value of GameProperty 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:key:GameProperty', gameProperty_key - The game property identifier.

$sel:value:GameProperty', gameProperty_value - The game property value.

gameProperty_key :: Lens' GameProperty Text

The game property identifier.

gameProperty_value :: Lens' GameProperty Text

The game property value.