Package software.amazon.awscdk.services.gamelift.alpha

Interface QueuedMatchmakingConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, MatchmakingConfigurationProps

All Known Implementing Classes:

QueuedMatchmakingConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:25.569Z")
@Stability(Experimental)
public interface QueuedMatchmakingConfigurationProps
extends software.amazon.jsii.JsiiSerializable, MatchmakingConfigurationProps

(experimental) Properties for a new queued matchmaking configuration.

Example:

 GameSessionQueue queue;
 MatchmakingRuleSet ruleSet;
 QueuedMatchmakingConfiguration.Builder.create(this, "QueuedMatchmakingConfiguration")
         .matchmakingConfigurationName("test-queued-config-name")
         .gameSessionQueues(List.of(queue))
         .ruleSet(ruleSet)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	QueuedMatchmakingConfigurationProps.Builder	A builder for QueuedMatchmakingConfigurationProps
static final class	QueuedMatchmakingConfigurationProps.Jsii$Proxy	An implementation for QueuedMatchmakingConfigurationProps

Method Summary

Modifier and Type	Method	Description
static QueuedMatchmakingConfigurationProps.Builder	builder()
default Number	getAdditionalPlayerCount()	(experimental) The number of player slots in a match to keep open for future players.
default List<GameProperty>	getGameProperties()	(experimental) A set of custom properties for a game session, formatted as key-value pairs.
default String	getGameSessionData()	(experimental) A set of custom game session properties, formatted as a single string value.
List<IGameSessionQueue>	getGameSessionQueues()	(experimental) Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration.
default Boolean	getManualBackfillMode()	(experimental) The method used to backfill game sessions that are created with this matchmaking configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.gamelift.alpha.MatchmakingConfigurationProps

getAcceptanceTimeout, getCustomEventData, getDescription, getMatchmakingConfigurationName, getNotificationTarget, getRequestTimeout, getRequireAcceptance, getRuleSet

Method Details

getGameSessionQueues

@Stability(Experimental)
@NotNull
List<IGameSessionQueue> getGameSessionQueues()

(experimental) 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.

getAdditionalPlayerCount

@Stability(Experimental)
@Nullable
default Number getAdditionalPlayerCount()

(experimental) 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.

Default: no additional player slots

getGameProperties

@Stability(Experimental)
@Nullable
default List<GameProperty> getGameProperties()

(experimental) 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.

Default: no additional game properties

See Also:

• https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession

getGameSessionData

@Stability(Experimental)
@Nullable
default String getGameSessionData()

(experimental) 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.

Default: no additional game session data

See Also:

• https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession

getManualBackfillMode

@Stability(Experimental)
@Nullable
default Boolean getManualBackfillMode()

(experimental) 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.

Default: automatic backfill mode

See Also:

• https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html

builder

@Stability(Experimental)
static QueuedMatchmakingConfigurationProps.Builder builder()

Returns:

a QueuedMatchmakingConfigurationProps.Builder of QueuedMatchmakingConfigurationProps