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	awscc.gamelift.matchmaking_rule_sets

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string	A unique identifier for the matchmaking rule set.
region	string	AWS region.

For more information, see AWS::GameLift::MatchmakingRuleSet.

Methods

Name	Resource	Accessible by	Required Params
create_resource	matchmaking_rule_sets	INSERT	Name, RuleSetBody, region
delete_resource	matchmaking_rule_sets	DELETE	Identifier, region
update_resource	matchmaking_rule_sets	UPDATE	Identifier, PatchDocument, region
list_resources	matchmaking_rule_sets_list_only	SELECT	region
get_resource	matchmaking_rule_sets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual matchmaking_rule_set.

SELECT
  region,
  name,
  rule_set_body,
  creation_time,
  arn,
  tags
FROM awscc.gamelift.matchmaking_rule_sets
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all matchmaking_rule_sets in a region.

SELECT
  region,
  name
FROM awscc.gamelift.matchmaking_rule_sets_list_only
WHERE
  region = 'us-east-1';

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 awscc.gamelift.matchmaking_rule_sets (
  Name,
  RuleSetBody,
  region
)
SELECT
  '{{ name }}',
  '{{ rule_set_body }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.gamelift.matchmaking_rule_sets (
  Name,
  RuleSetBody,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ rule_set_body }}',
  '{{ 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: rule_set_body
        value: '{{ rule_set_body }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.gamelift.matchmaking_rule_sets
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.gamelift.matchmaking_rule_sets
WHERE
  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