AWS::GameLift::MatchmakingConfiguration GameProperty

This key-value pair can store custom data about a game session. For example, you might use a GameProperty to track a game session's map, level of difficulty, or remaining time. The difficulty level could be specified like this: {"Key": "difficulty", "Value":"Novice"}.

You can set game properties when creating a game session. You can also modify game properties of an active game session. When searching for game sessions, you can filter on game property keys and values. You can't delete game properties from a game session.

For examples of working with game properties, see Create a game session with properties.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON


{
  "Key" : String,
  "Value" : String
}

YAML


  Key: String
  Value: String

Properties

Key

The game property identifier.

Required: Yes

Type: String

Maximum: 32

Update requires: No interruption

Value

The game property value.