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

Fields

get (all properties)

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.

list (identifiers only)

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

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	matchmaking_configurations	INSERT	AcceptanceRequired, Name, RequestTimeoutSeconds, RuleSetName, region
delete_resource	matchmaking_configurations	DELETE	Identifier, region
update_resource	matchmaking_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	matchmaking_configurations_list_only	SELECT	region
get_resource	matchmaking_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.gamelift.matchmaking_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all matchmaking_configurations in a region.

SELECT
  region,
  name
FROM awscc.gamelift.matchmaking_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.gamelift.matchmaking_configurations (
  AcceptanceRequired,
  Name,
  RequestTimeoutSeconds,
  RuleSetName,
  region
)
SELECT
  '{{ acceptance_required }}',
  '{{ name }}',
  '{{ request_timeout_seconds }}',
  '{{ rule_set_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.gamelift.matchmaking_configurations (
  AcceptanceRequired,
  AcceptanceTimeoutSeconds,
  AdditionalPlayerCount,
  BackfillMode,
  CreationTime,
  CustomEventData,
  Description,
  FlexMatchMode,
  GameProperties,
  GameSessionData,
  GameSessionQueueArns,
  Name,
  NotificationTarget,
  RequestTimeoutSeconds,
  RuleSetArn,
  RuleSetName,
  Tags,
  region
)
SELECT
  '{{ acceptance_required }}',
  '{{ acceptance_timeout_seconds }}',
  '{{ additional_player_count }}',
  '{{ backfill_mode }}',
  '{{ 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 }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: matchmaking_configuration
  props:
    - name: acceptance_required
      value: '{{ acceptance_required }}'
    - name: acceptance_timeout_seconds
      value: '{{ acceptance_timeout_seconds }}'
    - name: additional_player_count
      value: '{{ additional_player_count }}'
    - name: backfill_mode
      value: '{{ backfill_mode }}'
    - name: creation_time
      value: '{{ creation_time }}'
    - name: custom_event_data
      value: '{{ custom_event_data }}'
    - name: description
      value: '{{ description }}'
    - name: flex_match_mode
      value: '{{ flex_match_mode }}'
    - name: game_properties
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: game_session_data
      value: '{{ game_session_data }}'
    - name: game_session_queue_arns
      value:
        - '{{ game_session_queue_arns[0] }}'
    - name: name
      value: '{{ name }}'
    - name: notification_target
      value: '{{ notification_target }}'
    - name: request_timeout_seconds
      value: '{{ request_timeout_seconds }}'
    - name: rule_set_arn
      value: '{{ rule_set_arn }}'
    - name: rule_set_name
      value: '{{ rule_set_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.gamelift.matchmaking_configurations
SET PatchDocument = string('{{ {
    "AcceptanceRequired": acceptance_required,
    "AcceptanceTimeoutSeconds": acceptance_timeout_seconds,
    "AdditionalPlayerCount": additional_player_count,
    "BackfillMode": backfill_mode,
    "CreationTime": creation_time,
    "CustomEventData": custom_event_data,
    "Description": description,
    "FlexMatchMode": flex_match_mode,
    "GameProperties": game_properties,
    "GameSessionData": game_session_data,
    "GameSessionQueueArns": game_session_queue_arns,
    "NotificationTarget": notification_target,
    "RequestTimeoutSeconds": request_timeout_seconds,
    "RuleSetArn": rule_set_arn,
    "RuleSetName": rule_set_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.gamelift.matchmaking_configurations
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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