Class: AWSCDK::GameLift::CfnMatchmakingRuleSetProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
game_lift/cfn_matchmaking_rule_set_props.rb

Overview

Properties for defining a CfnMatchmakingRuleSet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, rule_set_body:, tags: nil) ⇒ CfnMatchmakingRuleSetProps

Returns a new instance of CfnMatchmakingRuleSetProps.

Parameters:

  • name (String) —

    A unique identifier for the matchmaking rule set.

  • rule_set_body (String) —

    A collection of matchmaking rules, formatted as a JSON string.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    A list of labels to assign to the new matchmaking rule set resource.



12
13
14
15
16
17
18
19
 
# File 'game_lift/cfn_matchmaking_rule_set_props.rb', line 12

def initialize(name:, rule_set_body:, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @rule_set_body = rule_set_body
  Jsii::Type.check_type(@rule_set_body, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleSetBody")
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#name ⇒ String (readonly)

A unique identifier for the matchmaking rule set.

A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

Returns:

  • (String)

See Also:



27
28
29
 
# File 'game_lift/cfn_matchmaking_rule_set_props.rb', line 27

def name
  @name
end

#rule_set_body ⇒ String (readonly)

A collection of matchmaking rules, formatted as a JSON string.

Comments are not allowed in JSON, but most elements support a description field.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'game_lift/cfn_matchmaking_rule_set_props.rb', line 34

def rule_set_body
  @rule_set_body
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

A list of labels to assign to the new matchmaking rule set resource.

Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

See Also:



41
42
43
 
# File 'game_lift/cfn_matchmaking_rule_set_props.rb', line 41

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
 
# File 'game_lift/cfn_matchmaking_rule_set_props.rb', line 43

def self.jsii_properties
  {
    :name => "name",
    :rule_set_body => "ruleSetBody",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 'game_lift/cfn_matchmaking_rule_set_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "ruleSetBody" => @rule_set_body,
    "tags" => @tags,
  })
  result.compact
end