matchmaking_configurations

Creates, updates, deletes or gets a matchmaking_configuration resource or lists matchmaking_configurations in a region

Overview

Name	matchmaking_configurations
Type	Resource
Description	The AWS::GameLift::MatchmakingConfiguration resource creates an Amazon GameLift (GameLift) matchmaking configuration.
Id	aws.gamelift.matchmaking_configurations

Fields

Name	Datatype	Description
acceptance_required	boolean	A flag that indicates whether a match that was created with this configuration must be accepted by the matched players
acceptance_timeout_seconds	integer	The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additional_player_count	integer	The number of player slots in a match to keep open for future players.
backfill_mode	string	The method used to backfill game sessions created with this matchmaking configuration.
arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it.
creation_time	string	A time stamp indicating when this data object was created.
custom_event_data	string	Information to attach to all events related to the matchmaking configuration.
description	string	A descriptive label that is associated with matchmaking configuration.
flex_match_mode	string	Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution.
game_properties	array	A set of custom properties for a game session, formatted as key:value pairs.
game_session_data	string	A set of custom game session properties, formatted as a single string value.
game_session_queue_arns	array	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
name	string	A unique identifier for the matchmaking configuration.
notification_target	string	An SNS topic ARN that is set up to receive matchmaking notifications.
request_timeout_seconds	integer	The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out.
rule_set_arn	string	The Amazon Resource Name (ARN) associated with the GameLift matchmaking rule set resource that this configuration uses.
rule_set_name	string	A unique identifier for the matchmaking rule set to use with this configuration.
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	AcceptanceRequired, Name, RequestTimeoutSeconds, RuleSetName, 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_configurations in a region.

SELECT
region,
acceptance_required,
acceptance_timeout_seconds,
additional_player_count,
backfill_mode,
arn,
creation_time,
custom_event_data,
description,
flex_match_mode,
game_properties,
game_session_data,
game_session_queue_arns,
name,
notification_target,
request_timeout_seconds,
rule_set_arn,
rule_set_name,
tags
FROM aws.gamelift.matchmaking_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual matchmaking_configuration.

SELECT
region,
acceptance_required,
acceptance_timeout_seconds,
additional_player_count,
backfill_mode,
arn,
creation_time,
custom_event_data,
description,
flex_match_mode,
game_properties,
game_session_data,
game_session_queue_arns,
name,
notification_target,
request_timeout_seconds,
rule_set_arn,
rule_set_name,
tags
FROM aws.gamelift.matchmaking_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.gamelift.matchmaking_configurations (
 AcceptanceRequired,
 Name,
 RequestTimeoutSeconds,
 RuleSetName,
 region
)
SELECT 
'{{ AcceptanceRequired }}',
 '{{ Name }}',
 '{{ RequestTimeoutSeconds }}',
 '{{ RuleSetName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.gamelift.matchmaking_configurations (
 AcceptanceRequired,
 AcceptanceTimeoutSeconds,
 AdditionalPlayerCount,
 BackfillMode,
 CreationTime,
 CustomEventData,
 Description,
 FlexMatchMode,
 GameProperties,
 GameSessionData,
 GameSessionQueueArns,
 Name,
 NotificationTarget,
 RequestTimeoutSeconds,
 RuleSetArn,
 RuleSetName,
 Tags,
 region
)
SELECT 
 '{{ AcceptanceRequired }}',
 '{{ AcceptanceTimeoutSeconds }}',
 '{{ AdditionalPlayerCount }}',
 '{{ BackfillMode }}',
 '{{ CreationTime }}',
 '{{ CustomEventData }}',
 '{{ Description }}',
 '{{ FlexMatchMode }}',
 '{{ GameProperties }}',
 '{{ GameSessionData }}',
 '{{ GameSessionQueueArns }}',
 '{{ Name }}',
 '{{ NotificationTarget }}',
 '{{ RequestTimeoutSeconds }}',
 '{{ RuleSetArn }}',
 '{{ RuleSetName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: matchmaking_configuration
    props:
      - name: AcceptanceRequired
        value: '{{ AcceptanceRequired }}'
      - name: AcceptanceTimeoutSeconds
        value: '{{ AcceptanceTimeoutSeconds }}'
      - name: AdditionalPlayerCount
        value: '{{ AdditionalPlayerCount }}'
      - name: BackfillMode
        value: '{{ BackfillMode }}'
      - name: CreationTime
        value: '{{ CreationTime }}'
      - name: CustomEventData
        value: '{{ CustomEventData }}'
      - name: Description
        value: '{{ Description }}'
      - name: FlexMatchMode
        value: '{{ FlexMatchMode }}'
      - name: GameProperties
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: GameSessionData
        value: '{{ GameSessionData }}'
      - name: GameSessionQueueArns
        value:
          - '{{ GameSessionQueueArns[0] }}'
      - name: Name
        value: '{{ Name }}'
      - name: NotificationTarget
        value: '{{ NotificationTarget }}'
      - name: RequestTimeoutSeconds
        value: '{{ RequestTimeoutSeconds }}'
      - name: RuleSetArn
        value: '{{ RuleSetArn }}'
      - name: RuleSetName
        value: '{{ RuleSetName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

gamelift:CreateMatchmakingConfiguration,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:DescribeMatchmakingConfigurations

Read

gamelift:DescribeMatchmakingConfigurations,
gamelift:ListTagsForResource

Delete

gamelift:DescribeMatchmakingConfigurations,
gamelift:DeleteMatchmakingConfiguration

List

gamelift:DescribeMatchmakingConfigurations

Update

gamelift:DescribeMatchmakingConfigurations,
gamelift:UpdateMatchmakingConfiguration,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:UntagResource