matchmaking_rule_sets

Creates, updates, deletes or gets a matchmaking_rule_set resource or lists matchmaking_rule_sets in a region

Overview

Name	matchmaking_rule_sets
Type	Resource
Description	The AWS::GameLift::MatchmakingRuleSet resource creates an Amazon GameLift (GameLift) matchmaking rule set.
Id	aws.gamelift.matchmaking_rule_sets

Fields

Name	Datatype	Description
name	string	A unique identifier for the matchmaking rule set.
rule_set_body	string	A collection of matchmaking rules, formatted as a JSON string.
creation_time	string	A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds.
arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, RuleSetBody, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all matchmaking_rule_sets in a region.

SELECT
region,
name,
rule_set_body,
creation_time,
arn,
tags
FROM aws.gamelift.matchmaking_rule_sets
WHERE region = 'us-east-1';

Gets all properties from an individual matchmaking_rule_set.

SELECT
region,
name,
rule_set_body,
creation_time,
arn,
tags
FROM aws.gamelift.matchmaking_rule_sets
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new matchmaking_rule_set resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.gamelift.matchmaking_rule_sets (
 Name,
 RuleSetBody,
 region
)
SELECT 
'{{ Name }}',
 '{{ RuleSetBody }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: matchmaking_rule_set
    props:
      - name: Name
        value: '{{ Name }}'
      - name: RuleSetBody
        value: '{{ RuleSetBody }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.gamelift.matchmaking_rule_sets
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the matchmaking_rule_sets resource, the following permissions are required:

Create

gamelift:CreateMatchmakingRuleSet,
gamelift:DescribeMatchmakingRuleSets,
gamelift:ValidateMatchmakingRuleSet,
gamelift:ListTagsForResource,
gamelift:TagResource

Read

gamelift:DescribeMatchmakingRuleSets,
gamelift:ValidateMatchmakingRuleSet,
gamelift:ListTagsForResource

Delete

gamelift:DeleteMatchmakingRuleSet

Update

gamelift:DescribeMatchmakingRuleSets,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:UntagResource

List

gamelift:DescribeMatchmakingRuleSets