Container for the parameters to the CreateMatchmakingConfiguration operation. Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used.
To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.
Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept.
Matchmaking status notification -- There are two ways to track the progress
of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking;
or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use
notifications, you first need to set up an SNS topic to receive the notifications,
and provide the topic ARN in the matchmaking configuration (see
Setting up Notifications for Matchmaking). Since notifications promise only "best
effort" delivery, we recommend calling DescribeMatchmaking if no notifications
are received within 30 seconds.
Operations related to match configurations and rule sets include:
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.CreateMatchmakingConfigurationRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class CreateMatchmakingConfigurationRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The CreateMatchmakingConfigurationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateMatchmakingConfigurationRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AcceptanceRequired | System.Boolean |
Gets and sets the property AcceptanceRequired. Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. |
|
|
AcceptanceTimeoutSeconds | System.Int32 |
Gets and sets the property AcceptanceTimeoutSeconds. Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match. |
|
|
AdditionalPlayerCount | System.Int32 |
Gets and sets the property AdditionalPlayerCount. Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. |
|
|
CustomEventData | System.String |
Gets and sets the property CustomEventData. Information to attached to all events related to the matchmaking configuration. |
|
|
Description | System.String |
Gets and sets the property Description. Meaningful description of the matchmaking configuration. |
|
|
GameProperties | System.Collections.Generic.List<Amazon.GameLift.Model.GameProperty> |
Gets and sets the property GameProperties. Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. |
|
|
GameSessionData | System.String |
Gets and sets the property GameSessionData. Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match. |
|
|
GameSessionQueueArns | System.Collections.Generic.List<System.String> |
Gets and sets the property GameSessionQueueArns.
Amazon Resource Name (ARN)
that is assigned to a game session queue and uniquely identifies it. Format is |
|
|
Name | System.String |
Gets and sets the property Name. Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket. |
|
|
NotificationTarget | System.String |
Gets and sets the property NotificationTarget. SNS topic ARN that is set up to receive matchmaking notifications. |
|
|
RequestTimeoutSeconds | System.Int32 |
Gets and sets the property RequestTimeoutSeconds. Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed. |
|
|
RuleSetName | System.String |
Gets and sets the property RuleSetName. Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region. |
Version Information
.NET Standard:
Supported in: 1.3
.NET Framework:
Supported in: 4.5, 4.0, 3.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms
