interface QueuedMatchmakingConfigurationProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.GameLift.Alpha.QueuedMatchmakingConfigurationProps |
Go | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#QueuedMatchmakingConfigurationProps |
Java | software.amazon.awscdk.services.gamelift.alpha.QueuedMatchmakingConfigurationProps |
Python | aws_cdk.aws_gamelift_alpha.QueuedMatchmakingConfigurationProps |
TypeScript (source) | @aws-cdk/aws-gamelift-alpha ยป QueuedMatchmakingConfigurationProps |
Properties for a new queued matchmaking configuration.
Example
declare const queue: gamelift.GameSessionQueue;
declare const ruleSet: gamelift.MatchmakingRuleSet;
new gamelift.QueuedMatchmakingConfiguration(this, 'QueuedMatchmakingConfiguration', {
matchmakingConfigurationName: 'test-queued-config-name',
gameSessionQueues: [queue],
ruleSet: ruleSet,
});
Properties
Name | Type | Description |
---|---|---|
game | IGame [] | Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. |
matchmaking | string | A unique identifier for the matchmaking configuration. |
rule | IMatchmaking | A matchmaking rule set to use with this configuration. |
acceptance | Duration | The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. |
additional | number | The number of player slots in a match to keep open for future players. |
custom | string | Information to add to all events related to the matchmaking configuration. |
description? | string | A human-readable description of the matchmaking configuration. |
game | Game [] | A set of custom properties for a game session, formatted as key-value pairs. |
game | string | A set of custom game session properties, formatted as a single string value. |
manual | boolean | The method used to backfill game sessions that are created with this matchmaking configuration. |
notification | ITopic | An SNS topic ARN that is set up to receive matchmaking notifications. |
request | Duration | The maximum duration, that a matchmaking ticket can remain in process before timing out. |
require | boolean | A flag that determines whether a match that was created with this configuration must be accepted by the matched players. |
gameSessionQueues
Type:
IGame
[]
Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration.
Queues can be located in any Region.
matchmakingConfigurationName
Type:
string
A unique identifier for the matchmaking configuration.
This name is used to identify the configuration associated with a matchmaking request or ticket.
ruleSet
Type:
IMatchmaking
A matchmaking rule set to use with this configuration.
A matchmaking configuration can only use rule sets that are defined in the same Region.
acceptanceTimeout?
Type:
Duration
(optional, default: 300 seconds)
The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.
additionalPlayerCount?
Type:
number
(optional, default: no additional player slots)
The 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?
Type:
string
(optional, default: no custom data added to events)
Information to add to all events related to the matchmaking configuration.
description?
Type:
string
(optional, default: no description is provided)
A human-readable description of the matchmaking configuration.
gameProperties?
Type:
Game
[]
(optional, default: no additional game properties)
A set of custom properties for a game session, formatted as key-value pairs.
These properties are passed to a game server process with a request to start a new game session.
gameSessionData?
Type:
string
(optional, default: no additional game session data)
A set of custom game session properties, formatted as a single string value.
This data is passed to a game server process with a request to start a new game session.
manualBackfillMode?
Type:
boolean
(optional, default: automatic backfill mode)
The method used to backfill game sessions that are created with this matchmaking configuration.
- Choose manual when your game manages backfill requests manually or does not use the match backfill feature.
- Otherwise backfill is settled to automatic to have GameLift create a
StartMatchBackfill
request whenever a game session has one or more open slots.
See also: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html
notificationTarget?
Type:
ITopic
(optional, default: no notification target)
An SNS topic ARN that is set up to receive matchmaking notifications.
See also: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
requestTimeout?
Type:
Duration
(optional, default: 300 seconds)
The maximum duration, that a matchmaking ticket can remain in process before timing out.
Requests that fail due to timing out can be resubmitted as needed.
requireAcceptance?
Type:
boolean
(optional, default: Acceptance is not required)
A flag that determines whether a match that was created with this configuration must be accepted by the matched players.
With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE
to indicate when a completed potential match is waiting for player acceptance.