Class: AWSCDK::GameLift::CfnMatchmakingRuleSet
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::GameLift::CfnMatchmakingRuleSet
- Includes:
- IInspectable, ITaggable, Interfaces::AWSGamelift::IMatchmakingRuleSetRef
- Defined in:
- game_lift/cfn_matchmaking_rule_set.rb
Overview
Creates a new rule set for FlexMatch matchmaking.
A rule set describes the type of match to create, such as the number and size of teams. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.
To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.
Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax.
Learn more
Class Method Summary collapse
- .arn_for_matchmaking_rule_set(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_matchmaking_rule_set_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSGamelift::IMatchmakingRuleSetRef
Creates a new IMatchmakingRuleSetRef from an ARN.
-
.from_matchmaking_rule_set_name(scope, id, matchmaking_rule_set_name) ⇒ AWSCDK::Interfaces::AWSGamelift::IMatchmakingRuleSetRef
Creates a new IMatchmakingRuleSetRef from a matchmakingRuleSetName.
-
.is_cfn_matchmaking_rule_set(x) ⇒ Boolean
Checks whether the given object is a CfnMatchmakingRuleSet.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#attr_arn ⇒ String
The unique Amazon Resource Name (ARN) assigned to the rule set.
-
#attr_creation_time ⇒ String
A time stamp indicating when this data object was created.
-
#attr_name ⇒ String
The unique name of the rule set.
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
- #creation_stack ⇒ Array<String>
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnMatchmakingRuleSet
constructor
Create a new
AWS::GameLift::MatchmakingRuleSet. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#matchmaking_rule_set_ref ⇒ AWSCDK::Interfaces::AWSGamelift::MatchmakingRuleSetReference
A reference to a MatchmakingRuleSet resource.
-
#name ⇒ String
A unique identifier for the matchmaking rule set.
- #name=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#rule_set_body ⇒ String
A collection of matchmaking rules, formatted as a JSON string.
- #rule_set_body=(value) ⇒ Object
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
A list of labels to assign to the new matchmaking rule set resource.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnMatchmakingRuleSet
Create a new AWS::GameLift::MatchmakingRuleSet.
30 31 32 33 34 35 36 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 30 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::GameLift::CfnMatchmakingRuleSetProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuTWF0Y2htYWtpbmdSdWxlU2V0UHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_matchmaking_rule_set(resource) ⇒ String
88 89 90 91 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 88 def self.arn_for_matchmaking_rule_set(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nYW1lbGlmdC5JTWF0Y2htYWtpbmdSdWxlU2V0UmVmIn0=")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingRuleSet", "arnForMatchmakingRuleSet", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
221 222 223 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 221 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingRuleSet", "CFN_RESOURCE_TYPE_NAME") end |
.from_matchmaking_rule_set_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSGamelift::IMatchmakingRuleSetRef
Creates a new IMatchmakingRuleSetRef from an ARN.
99 100 101 102 103 104 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 99 def self.from_matchmaking_rule_set_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.CfnMatchmakingRuleSet", "fromMatchmakingRuleSetArn", [scope, id, arn]) end |
.from_matchmaking_rule_set_name(scope, id, matchmaking_rule_set_name) ⇒ AWSCDK::Interfaces::AWSGamelift::IMatchmakingRuleSetRef
Creates a new IMatchmakingRuleSetRef from a matchmakingRuleSetName.
112 113 114 115 116 117 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 112 def self.from_matchmaking_rule_set_name(scope, id, matchmaking_rule_set_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_rule_set_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "matchmakingRuleSetName") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingRuleSet", "fromMatchmakingRuleSetName", [scope, id, matchmaking_rule_set_name]) end |
.is_cfn_matchmaking_rule_set(x) ⇒ Boolean
Checks whether the given object is a CfnMatchmakingRuleSet.
123 124 125 126 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 123 def self.is_cfn_matchmaking_rule_set(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnMatchmakingRuleSet", "isCfnMatchmakingRuleSet", [x]) end |
.jsii_overridable_methods ⇒ Object
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 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 38 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_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false }, :attr_name => { kind: :property, name: "attrName", is_optional: false }, :matchmaking_rule_set_ref => { kind: :property, name: "matchmakingRuleSetRef", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :name => { kind: :property, name: "name", is_optional: false }, :rule_set_body => { kind: :property, name: "ruleSetBody", is_optional: false }, :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
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
335 336 337 338 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 335 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.
347 348 349 350 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 347 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
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.
357 358 359 360 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 357 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.
368 369 370 371 372 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 368 def (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.
425 426 427 428 429 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 425 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.
435 436 437 438 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 435 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).
447 448 449 450 451 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 447 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 |
#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.
460 461 462 463 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 460 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:
482 483 484 485 486 487 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 482 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_arn ⇒ String
The unique Amazon Resource Name (ARN) assigned to the rule set.
228 229 230 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 228 def attr_arn() jsii_get_property("attrArn") end |
#attr_creation_time ⇒ String
A time stamp indicating when this data object was created.
Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).
237 238 239 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 237 def attr_creation_time() jsii_get_property("attrCreationTime") end |
#attr_name ⇒ String
The unique name of the rule set.
244 245 246 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 244 def attr_name() jsii_get_property("attrName") end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
174 175 176 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 174 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
179 180 181 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 179 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
491 492 493 494 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 491 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}
184 185 186 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 184 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
191 192 193 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 191 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#creation_stack ⇒ Array<String>
136 137 138 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 136 def creation_stack() jsii_get_property("creationStack") end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
196 197 198 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 196 def env() jsii_get_property("env") 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.
504 505 506 507 508 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 504 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.
515 516 517 518 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 515 def (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.
585 586 587 588 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 585 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).
148 149 150 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 148 def logical_id() jsii_get_property("logicalId") end |
#matchmaking_rule_set_ref ⇒ AWSCDK::Interfaces::AWSGamelift::MatchmakingRuleSetReference
A reference to a MatchmakingRuleSet resource.
251 252 253 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 251 def matchmaking_rule_set_ref() jsii_get_property("matchmakingRuleSetRef") end |
#name ⇒ String
A unique identifier for the matchmaking rule set.
265 266 267 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 265 def name() jsii_get_property("name") end |
#name=(value) ⇒ Object
269 270 271 272 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 269 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.
131 132 133 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 131 def node() jsii_get_property("node") 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.
526 527 528 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 526 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.
533 534 535 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 533 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.
326 327 328 329 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 326 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 }).
167 168 169 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 167 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.
544 545 546 547 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 544 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}
551 552 553 554 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 551 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.
561 562 563 564 565 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 561 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 |
#rule_set_body ⇒ String
A collection of matchmaking rules, formatted as a JSON string.
277 278 279 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 277 def rule_set_body() jsii_get_property("ruleSetBody") end |
#rule_set_body=(value) ⇒ Object
281 282 283 284 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 281 def rule_set_body=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ruleSetBody") jsii_set_property("ruleSetBody", value) end |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
570 571 572 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 570 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).
157 158 159 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 157 def stack() jsii_get_property("stack") end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
258 259 260 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 258 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
A list of labels to assign to the new matchmaking rule set resource.
289 290 291 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 289 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
293 294 295 296 297 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 293 def (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.
302 303 304 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 302 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
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.
204 205 206 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 204 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.
214 215 216 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 214 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
576 577 578 579 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 576 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.
315 316 317 318 319 320 |
# File 'game_lift/cfn_matchmaking_rule_set.rb', line 315 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 |