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

Class QueuedMatchmakingConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.gamelift.alpha.MatchmakingConfigurationBase

software.amazon.awscdk.services.gamelift.alpha.QueuedMatchmakingConfiguration

All Implemented Interfaces:

IResource, IMatchmakingConfiguration, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:18.876Z")
@Stability(Experimental)
public class QueuedMatchmakingConfiguration
extends MatchmakingConfigurationBase

(experimental) A FlexMatch matchmaker process does the work of building a game match.

It manages the pool of matchmaking requests received, forms teams for a match, processes and selects players to find the best possible player groups, and initiates the process of placing and starting a game session for the match. This topic describes the key aspects of a matchmaker and how to configure one customized for your game.

Example:

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

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	QueuedMatchmakingConfiguration.Builder	(experimental) A fluent builder for QueuedMatchmakingConfiguration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.gamelift.alpha.IMatchmakingConfiguration

IMatchmakingConfiguration.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	QueuedMatchmakingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	QueuedMatchmakingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
	QueuedMatchmakingConfiguration(software.constructs.Construct scope, String id, QueuedMatchmakingConfigurationProps props)

Method Summary

Modifier and Type	Method	Description
void	addGameSessionQueue(IGameSessionQueue gameSessionQueue)	(experimental) Adds a game session queue destination to the matchmaking configuration.
static IMatchmakingConfiguration	fromQueuedMatchmakingConfigurationArn(software.constructs.Construct scope, String id, String matchmakingConfigurationArn)	(experimental) Import an existing matchmaking configuration from its ARN.
static IMatchmakingConfiguration	fromQueuedMatchmakingConfigurationName(software.constructs.Construct scope, String id, String matchmakingConfigurationName)	(experimental) Import an existing matchmaking configuration from its name.
String	getMatchmakingConfigurationArn()	(experimental) The ARN of the matchmaking configuration.
String	getMatchmakingConfigurationName()	(experimental) The name of the matchmaking configuration.
ITopic	getNotificationTarget()	(experimental) The notification target for matchmaking events.

Methods inherited from class software.amazon.awscdk.services.gamelift.alpha.MatchmakingConfigurationBase

fromMatchmakingConfigurationAttributes, metric, metric, metricCurrentTickets, metricCurrentTickets, metricMatchesAccepted, metricMatchesAccepted, metricMatchesCreated, metricMatchesCreated, metricMatchesPlaced, metricMatchesPlaced, metricMatchesRejected, metricMatchesRejected, metricPlayersStarted, metricPlayersStarted, metricTimeToMatch, metricTimeToMatch

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

QueuedMatchmakingConfiguration

protected QueuedMatchmakingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

QueuedMatchmakingConfiguration

protected QueuedMatchmakingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

QueuedMatchmakingConfiguration

@Stability(Experimental)
public QueuedMatchmakingConfiguration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 QueuedMatchmakingConfigurationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromQueuedMatchmakingConfigurationArn

@Stability(Experimental)
@NotNull
public static IMatchmakingConfiguration fromQueuedMatchmakingConfigurationArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String matchmakingConfigurationArn)

(experimental) Import an existing matchmaking configuration from its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

matchmakingConfigurationArn - This parameter is required.

fromQueuedMatchmakingConfigurationName

@Stability(Experimental)
@NotNull
public static IMatchmakingConfiguration fromQueuedMatchmakingConfigurationName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String matchmakingConfigurationName)

(experimental) Import an existing matchmaking configuration from its name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

matchmakingConfigurationName - This parameter is required.

addGameSessionQueue

@Stability(Experimental)
public void addGameSessionQueue(@NotNull
 IGameSessionQueue gameSessionQueue)

(experimental) Adds a game session queue destination to the matchmaking configuration.

Parameters:

gameSessionQueue - A game session queue. This parameter is required.

getMatchmakingConfigurationArn

@Stability(Experimental)
@NotNull
public String getMatchmakingConfigurationArn()

(experimental) The ARN of the matchmaking configuration.

Specified by:

getMatchmakingConfigurationArn in interface IMatchmakingConfiguration

Specified by:

getMatchmakingConfigurationArn in class MatchmakingConfigurationBase

getMatchmakingConfigurationName

@Stability(Experimental)
@NotNull
public String getMatchmakingConfigurationName()

(experimental) The name of the matchmaking configuration.

Specified by:

getMatchmakingConfigurationName in interface IMatchmakingConfiguration

Specified by:

getMatchmakingConfigurationName in class MatchmakingConfigurationBase

getNotificationTarget

@Stability(Experimental)
@Nullable
public ITopic getNotificationTarget()

(experimental) The notification target for matchmaking events.

Specified by:

getNotificationTarget in interface IMatchmakingConfiguration

Specified by:

getNotificationTarget in class MatchmakingConfigurationBase