matchmaking_configuration

Gets an individual matchmaking_configuration resource

Overview

Name	matchmaking_configuration
Type	Resource
Description	matchmaking_configuration
Id	awscc.gamelift.matchmaking_configuration

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

Currently only SELECT is supported for this resource resource.

Example

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_configuration
WHERE data__Identifier = '<Name>';

Permissions

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

Read

gamelift:DescribeMatchmakingConfigurations,
gamelift:ListTagsForResource

Delete

gamelift:DescribeMatchmakingConfigurations,
gamelift:DeleteMatchmakingConfiguration

Update

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