matchmaking_rule_sets

Creates, updates, deletes, gets or lists a matchmaking_rule_sets resource.

Overview

Name	matchmaking_rule_sets
Type	Resource
Id	aws.gamelift.matchmaking_rule_sets

Fields

The following fields are returned by SELECT queries:

describe_matchmaking_rule_sets

Name	Datatype	Description
creation_time	string (date-time)	A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
rule_set_arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name>. In a GameLift rule set ARN, the resource ID matches the RuleSetName value. (pattern: <code>^arn:.:matchmakingruleset/[a-zA-Z0-9-.]$</code>)
rule_set_body	string	A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
rule_set_name	string	A unique identifier for the matchmaking rule set (pattern: <code>^[a-zA-Z0-9-.]*$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_matchmaking_rule_sets	select	region		This API works with the following fleet types: EC2, Anywhere, Container Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name. Learn more Build a rule set
create_matchmaking_rule_set	insert	region, Name, RuleSetBody		This API works with the following fleet types: EC2, Anywhere, Container 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 using ValidateMatchmakingRuleSet before creating a new rule set. Learn more Build a rule set Design a matchmaker Matchmaking with FlexMatch
delete_matchmaking_rule_set	delete	region		This API works with the following fleet types: EC2, Anywhere, Container Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration. Learn more Build a rule set

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_matchmaking_rule_sets

This API works with the following fleet types: EC2, Anywhere, Container Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name. Learn more Build a rule set

SELECT
creation_time,
rule_set_arn,
rule_set_body,
rule_set_name
FROM aws.gamelift.matchmaking_rule_sets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_matchmaking_rule_set

This API works with the following fleet types: EC2, Anywhere, Container 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 using ValidateMatchmakingRuleSet before creating a new rule set. Learn more Build a rule set Design a matchmaker Matchmaking with FlexMatch

INSERT INTO aws.gamelift.matchmaking_rule_sets (
Name,
RuleSetBody,
Tags,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ RuleSetBody }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
rule_set
;

Manifest

# Description fields are for documentation purposes
- name: matchmaking_rule_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the matchmaking_rule_sets resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      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.
  - name: RuleSetBody
    value: "{{ RuleSetBody }}"
    description: |
      A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.
  - name: Tags
    description: |
      A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

DELETE examples

delete_matchmaking_rule_set

This API works with the following fleet types: EC2, Anywhere, Container Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration. Learn more Build a rule set

DELETE FROM aws.gamelift.matchmaking_rule_sets
WHERE region = '{{ region }}' --required
;