Experimental
@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
QueuedMatchmakingConfigurationProps Struct
Properties for a new queued matchmaking configuration.
| Stability | Experimental |
|---|---|
| Source | lib/queued-matchmaking-configuration.ts |
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,
});
# queue: gamelift.GameSessionQueue
# rule_set: gamelift.MatchmakingRuleSet
gamelift.QueuedMatchmakingConfiguration(self, "QueuedMatchmakingConfiguration",
matchmaking_configuration_name="test-queued-config-name",
game_session_queues=[queue],
rule_set=rule_set
)
GameSessionQueue queue;
MatchmakingRuleSet ruleSet;
QueuedMatchmakingConfiguration.Builder.create(this, "QueuedMatchmakingConfiguration")
.matchmakingConfigurationName("test-queued-config-name")
.gameSessionQueues(List.of(queue))
.ruleSet(ruleSet)
.build();
// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
GameSessionQueue queue;
MatchmakingRuleSet ruleSet;
new QueuedMatchmakingConfiguration(this, "QueuedMatchmakingConfiguration", new QueuedMatchmakingConfigurationProps {
MatchmakingConfigurationName = "test-queued-config-name",
GameSessionQueues = new [] { queue },
RuleSet = ruleSet
});
// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
var queue GameSessionQueue
var ruleSet MatchmakingRuleSet
gamelift.NewQueuedMatchmakingConfiguration(this, jsii.String("QueuedMatchmakingConfiguration"), &QueuedMatchmakingConfigurationProps{
MatchmakingConfigurationName: jsii.String("test-queued-config-name"),
GameSessionQueues: []IGameSessionQueue{
queue,
},
RuleSet: ruleSet,
})
Properties
acceptanceTimeoutoptionalDurationacceptance_timeoutoptionalDurationacceptanceTimeoutoptionalDurationAcceptanceTimeoutoptionalDurationAcceptanceTimeoutoptionalDuration #Default: 300 seconds
additionalPlayerCountoptionalnumberadditional_player_countoptionalint | floatadditionalPlayerCountoptionalNumberAdditionalPlayerCountoptionaldoubleAdditionalPlayerCountoptional*float64 #Default: no additional player slots
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.
customEventDataoptionalstringcustom_event_dataoptionalstrcustomEventDataoptionalStringCustomEventDataoptionalstringCustomEventDataoptional*string #Default: no custom data added to events
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #Default: no description is provided
gamePropertiesoptionalGameProperty[]game_propertiesoptionaltyping.List[GameProperty]gamePropertiesoptionalList<GameProperty>GamePropertiesoptionalGameProperty[]GamePropertiesoptional*[]GameProperty #Default: no additional game properties
These properties are passed to a game server process with a request to start a new game session.
gameSessionDataoptionalstringgame_session_dataoptionalstrgameSessionDataoptionalStringGameSessionDataoptionalstringGameSessionDataoptional*string #Default: no additional game session data
This data is passed to a game server process with a request to start a new game session.
gameSessionQueuesIGameSessionQueue[]game_session_queuestyping.List[IGameSessionQueue]gameSessionQueuesList<IGameSessionQueue>GameSessionQueuesIGameSessionQueue[]GameSessionQueues*[]IGameSessionQueue required #Queues can be located in any Region.
manualBackfillModeoptionalbooleanmanual_backfill_modeoptionalboolmanualBackfillModeoptionalBooleanManualBackfillModeoptionalboolManualBackfillModeoptional*bool #Default: automatic backfill mode
notes
- 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
StartMatchBackfillrequest whenever a game session has one or more open slots.
matchmakingConfigurationNamestringmatchmaking_configuration_namestrmatchmakingConfigurationNameStringMatchmakingConfigurationNamestringMatchmakingConfigurationName*string required #This name is used to identify the configuration associated with a matchmaking request or ticket.
notificationTargetoptionalITopicnotification_targetoptionalITopicnotificationTargetoptionalITopicNotificationTargetoptionalITopicNotificationTargetoptionalITopic #Default: no notification target
requestTimeoutoptionalDurationrequest_timeoutoptionalDurationrequestTimeoutoptionalDurationRequestTimeoutoptionalDurationRequestTimeoutoptionalDuration #Default: 300 seconds
Requests that fail due to timing out can be resubmitted as needed.
requireAcceptanceoptionalbooleanrequire_acceptanceoptionalboolrequireAcceptanceoptionalBooleanRequireAcceptanceoptionalboolRequireAcceptanceoptional*bool #Default: Acceptance is not required
With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.
ruleSetIMatchmakingRuleSetrule_setIMatchmakingRuleSetruleSetIMatchmakingRuleSetRuleSetIMatchmakingRuleSetRuleSetIMatchmakingRuleSet required #A matchmaking configuration can only use rule sets that are defined in the same Region.