Class: AWSCDK::GameLift::CfnMatchmakingConfiguration

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSGamelift::IMatchmakingConfigurationRef
Defined in:
game_lift/cfn_matchmaking_configuration.rb

Overview

The AWS::GameLift::MatchmakingConfiguration resource defines a new matchmaking configuration for use with FlexMatch.

Whether you're using FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're using GameLift hosting, it also defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes that are consistent with that configuration.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMatchmakingConfiguration

Create a new AWS::GameLift::MatchmakingConfiguration.

Parameters:



20
21
22
23
24
25
26
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::GameLift::CfnMatchmakingConfigurationProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuTWF0Y2htYWtpbmdDb25maWd1cmF0aW9uUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_matchmaking_configuration(resource) ⇒ String

Parameters:

Returns:

  • (String) 


91
92
93
94
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 91

def self.arn_for_matchmaking_configuration(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nYW1lbGlmdC5JTWF0Y2htYWtpbmdDb25maWd1cmF0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingConfiguration", "arnForMatchmakingConfiguration", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


224
225
226
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 224

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingConfiguration", "CFN_RESOURCE_TYPE_NAME")
end

.from_matchmaking_configuration_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSGamelift::IMatchmakingConfigurationRef

Creates a new IMatchmakingConfigurationRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



102
103
104
105
106
107
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 102

def self.from_matchmaking_configuration_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingConfiguration", "fromMatchmakingConfigurationArn", [scope, id, arn])
end

.from_matchmaking_configuration_name(scope, id, matchmaking_configuration_name) ⇒ AWSCDK::Interfaces::AWSGamelift::IMatchmakingConfigurationRef

Creates a new IMatchmakingConfigurationRef from a matchmakingConfigurationName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • matchmaking_configuration_name (String)

Returns:



115
116
117
118
119
120
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 115

def self.from_matchmaking_configuration_name(scope, id, matchmaking_configuration_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(matchmaking_configuration_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "matchmakingConfigurationName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingConfiguration", "fromMatchmakingConfigurationName", [scope, id, matchmaking_configuration_name])
end

.is_cfn_matchmaking_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnMatchmakingConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


126
127
128
129
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 126

def self.is_cfn_matchmaking_configuration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingConfiguration", "isCfnMatchmakingConfiguration", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :matchmaking_configuration_ref => { kind: :property, name: "matchmakingConfigurationRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :acceptance_required => { kind: :property, name: "acceptanceRequired", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :request_timeout_seconds => { kind: :property, name: "requestTimeoutSeconds", is_optional: false },
    :rule_set_name => { kind: :property, name: "ruleSetName", is_optional: false },
    :acceptance_timeout_seconds => { kind: :property, name: "acceptanceTimeoutSeconds", is_optional: true },
    :additional_player_count => { kind: :property, name: "additionalPlayerCount", is_optional: true },
    :backfill_mode => { kind: :property, name: "backfillMode", is_optional: true },
    :creation_time => { kind: :property, name: "creationTime", is_optional: true },
    :custom_event_data => { kind: :property, name: "customEventData", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :flex_match_mode => { kind: :property, name: "flexMatchMode", is_optional: true },
    :game_properties => { kind: :property, name: "gameProperties", is_optional: true },
    :game_session_data => { kind: :property, name: "gameSessionData", is_optional: true },
    :game_session_queue_arns => { kind: :property, name: "gameSessionQueueArns", is_optional: true },
    :notification_target => { kind: :property, name: "notificationTarget", is_optional: true },
    :rule_set_arn => { kind: :property, name: "ruleSetArn", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#acceptance_required ⇒ Boolean, AWSCDK::IResolvable

A flag that determines whether a match that was created with this configuration must be accepted by the matched players.

Returns:



259
260
261
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 259

def acceptance_required()
  jsii_get_property("acceptanceRequired")
end

#acceptance_required=(value) ⇒ Object 



263
264
265
266
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 263

def acceptance_required=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "acceptanceRequired")
  jsii_set_property("acceptanceRequired", value)
end

#acceptance_timeout_seconds ⇒ Numeric?

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

Returns:

  • (Numeric, nil) 


307
308
309
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 307

def acceptance_timeout_seconds()
  jsii_get_property("acceptanceTimeoutSeconds")
end

#acceptance_timeout_seconds=(value) ⇒ Object 



311
312
313
314
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 311

def acceptance_timeout_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "acceptanceTimeoutSeconds") unless value.nil?
  jsii_set_property("acceptanceTimeoutSeconds", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



497
498
499
500
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 497

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



509
510
511
512
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 509

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



519
520
521
522
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 519

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



530
531
532
533
534
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 530

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


587
588
589
590
591
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 587

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



597
598
599
600
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 597

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



609
610
611
612
613
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 609

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#additional_player_count ⇒ Numeric?

The number of player slots in a match to keep open for future players.

Returns:

  • (Numeric, nil) 


319
320
321
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 319

def additional_player_count()
  jsii_get_property("additionalPlayerCount")
end

#additional_player_count=(value) ⇒ Object 



323
324
325
326
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 323

def additional_player_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "additionalPlayerCount") unless value.nil?
  jsii_set_property("additionalPlayerCount", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



622
623
624
625
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 622

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



644
645
646
647
648
649
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 644

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The unique Amazon Resource Name (ARN) for the MatchmakingConfiguration .

Returns:

  • (String) 


231
232
233
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 231

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_name ⇒ String

The MatchmakingConfiguration name, which is unique.

Returns:

  • (String) 


238
239
240
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 238

def attr_name()
  jsii_get_property("attrName")
end

#backfill_mode ⇒ String?

The method used to backfill game sessions that are created with this matchmaking configuration.

Returns:

  • (String, nil) 


331
332
333
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 331

def backfill_mode()
  jsii_get_property("backfillMode")
end

#backfill_mode=(value) ⇒ Object 



335
336
337
338
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 335

def backfill_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "backfillMode") unless value.nil?
  jsii_set_property("backfillMode", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



177
178
179
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 177

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


182
183
184
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 182

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


653
654
655
656
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 653

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


187
188
189
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 187

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


194
195
196
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 194

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


139
140
141
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 139

def creation_stack()
  jsii_get_property("creationStack")
end

#creation_time ⇒ String?

A time stamp indicating when this data object was created.

Returns:

  • (String, nil) 


343
344
345
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 343

def creation_time()
  jsii_get_property("creationTime")
end

#creation_time=(value) ⇒ Object 



347
348
349
350
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 347

def creation_time=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "creationTime") unless value.nil?
  jsii_set_property("creationTime", value)
end

#custom_event_data ⇒ String?

Information to add to all events related to the matchmaking configuration.

Returns:

  • (String, nil) 


355
356
357
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 355

def custom_event_data()
  jsii_get_property("customEventData")
end

#custom_event_data=(value) ⇒ Object 



359
360
361
362
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 359

def custom_event_data=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customEventData") unless value.nil?
  jsii_set_property("customEventData", value)
end

#description ⇒ String?

A description for the matchmaking configuration.

Returns:

  • (String, nil) 


367
368
369
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 367

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



371
372
373
374
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 371

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



199
200
201
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 199

def env()
  jsii_get_property("env")
end

#flex_match_mode ⇒ String?

Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.

Returns:

  • (String, nil) 


379
380
381
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 379

def flex_match_mode()
  jsii_get_property("flexMatchMode")
end

#flex_match_mode=(value) ⇒ Object 



383
384
385
386
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 383

def flex_match_mode=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "flexMatchMode") unless value.nil?
  jsii_set_property("flexMatchMode", value)
end

#game_properties ⇒ AWSCDK::IResolvable, ...

A set of custom properties for a game session, formatted as key-value pairs.

Returns:



391
392
393
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 391

def game_properties()
  jsii_get_property("gameProperties")
end

#game_properties=(value) ⇒ Object 



395
396
397
398
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 395

def game_properties=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuTWF0Y2htYWtpbmdDb25maWd1cmF0aW9uLkdhbWVQcm9wZXJ0eVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "gameProperties") unless value.nil?
  jsii_set_property("gameProperties", value)
end

#game_session_data ⇒ String?

A set of custom game session properties, formatted as a single string value.

Returns:

  • (String, nil) 


403
404
405
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 403

def game_session_data()
  jsii_get_property("gameSessionData")
end

#game_session_data=(value) ⇒ Object 



407
408
409
410
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 407

def game_session_data=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gameSessionData") unless value.nil?
  jsii_set_property("gameSessionData", value)
end

#game_session_queue_arns ⇒ Array<String>?

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name> . Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE , do not set this parameter.

Returns:

  • (Array<String>, nil) 


415
416
417
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 415

def game_session_queue_arns()
  jsii_get_property("gameSessionQueueArns")
end

#game_session_queue_arns=(value) ⇒ Object 



419
420
421
422
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 419

def game_session_queue_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "gameSessionQueueArns") unless value.nil?
  jsii_set_property("gameSessionQueueArns", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



666
667
668
669
670
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 666

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



677
678
679
680
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 677

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



747
748
749
750
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 747

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


151
152
153
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 151

def logical_id()
  jsii_get_property("logicalId")
end

#matchmaking_configuration_ref ⇒ AWSCDK::Interfaces::AWSGamelift::MatchmakingConfigurationReference

A reference to a MatchmakingConfiguration resource.

Returns:



245
246
247
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 245

def matchmaking_configuration_ref()
  jsii_get_property("matchmakingConfigurationRef")
end

#name ⇒ String

A unique identifier for the matchmaking configuration.

Returns:

  • (String) 


271
272
273
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 271

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



275
276
277
278
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 275

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


134
135
136
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 134

def node()
  jsii_get_property("node")
end

#notification_target ⇒ String?

An SNS topic ARN that is set up to receive matchmaking notifications.

Returns:

  • (String, nil) 


427
428
429
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 427

def notification_target()
  jsii_get_property("notificationTarget")
end

#notification_target=(value) ⇒ Object 



431
432
433
434
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 431

def notification_target=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationTarget") unless value.nil?
  jsii_set_property("notificationTarget", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



688
689
690
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 688

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



695
696
697
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 695

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



488
489
490
491
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 488

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


170
171
172
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 170

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



706
707
708
709
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 706

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


713
714
715
716
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 713

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



723
724
725
726
727
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 723

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#request_timeout_seconds ⇒ Numeric

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.

Returns:

  • (Numeric) 


283
284
285
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 283

def request_timeout_seconds()
  jsii_get_property("requestTimeoutSeconds")
end

#request_timeout_seconds=(value) ⇒ Object 



287
288
289
290
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 287

def request_timeout_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "requestTimeoutSeconds")
  jsii_set_property("requestTimeoutSeconds", value)
end

#rule_set_arn ⇒ String?

The Amazon Resource Name ( ARN ) associated with the GameLift matchmaking rule set resource that this configuration uses.

Returns:

  • (String, nil) 


439
440
441
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 439

def rule_set_arn()
  jsii_get_property("ruleSetArn")
end

#rule_set_arn=(value) ⇒ Object 



443
444
445
446
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 443

def rule_set_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleSetArn") unless value.nil?
  jsii_set_property("ruleSetArn", value)
end

#rule_set_name ⇒ String

A unique identifier for the matchmaking rule set to use with this configuration.

Returns:

  • (String) 


295
296
297
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 295

def rule_set_name()
  jsii_get_property("ruleSetName")
end

#rule_set_name=(value) ⇒ Object 



299
300
301
302
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 299

def rule_set_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleSetName")
  jsii_set_property("ruleSetName", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



732
733
734
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 732

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



160
161
162
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 160

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



252
253
254
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 252

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A list of labels to assign to the new matchmaking configuration resource.

Returns:



451
452
453
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 451

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



455
456
457
458
459
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 455

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



464
465
466
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 464

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


207
208
209
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 207

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


217
218
219
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 217

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


738
739
740
741
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 738

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


477
478
479
480
481
482
 
# File 'game_lift/cfn_matchmaking_configuration.rb', line 477

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end