Class: AWSCDK::GameLift::CfnMatchmakingConfiguration::GamePropertyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::GameLift::CfnMatchmakingConfiguration::GamePropertyProperty

Defined in:

game_lift/cfn_matchmaking_configuration.rb

Overview

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html

Instance Attribute Summary

• #key ⇒ String readonly

  The game property identifier.

• #value ⇒ String readonly

  The game property value.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(key:, value:) ⇒ GamePropertyProperty constructor

  A new instance of GamePropertyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(key:, value:) ⇒ GamePropertyProperty

Returns a new instance of GamePropertyProperty.

Parameters:

• key (String) —

  The game property identifier.

• value (String) —

  The game property value.

# File 'game_lift/cfn_matchmaking_configuration.rb', line 768

def initialize(key:, value:)
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value")
end

Instance Attribute Details

#key ⇒ String (readonly)

The game property identifier.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-key

# File 'game_lift/cfn_matchmaking_configuration.rb', line 779

def key
  @key
end

#value ⇒ String (readonly)

The game property value.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-matchmakingconfiguration-gameproperty.html#cfn-gamelift-matchmakingconfiguration-gameproperty-value

# File 'game_lift/cfn_matchmaking_configuration.rb', line 784

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'game_lift/cfn_matchmaking_configuration.rb', line 786

def self.jsii_properties
  {
    :key => "key",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'game_lift/cfn_matchmaking_configuration.rb', line 793

def to_jsii
  result = {}
  result.merge!({
    "key" => @key,
    "value" => @value,
  })
  result.compact
end