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

Class QueuedMatchmakingConfigurationProps.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.alpha.QueuedMatchmakingConfigurationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<QueuedMatchmakingConfigurationProps>

Enclosing interface:

QueuedMatchmakingConfigurationProps

@Stability(Experimental)
public static final class QueuedMatchmakingConfigurationProps.Builder
extends Object
implements software.amazon.jsii.Builder<QueuedMatchmakingConfigurationProps>

A builder for QueuedMatchmakingConfigurationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QueuedMatchmakingConfigurationProps.Builder	acceptanceTimeout(Duration acceptanceTimeout)	Sets the value of MatchmakingConfigurationProps.getAcceptanceTimeout()
QueuedMatchmakingConfigurationProps.Builder	additionalPlayerCount(Number additionalPlayerCount)	Sets the value of QueuedMatchmakingConfigurationProps.getAdditionalPlayerCount()
QueuedMatchmakingConfigurationProps	build()	Builds the configured instance.
QueuedMatchmakingConfigurationProps.Builder	customEventData(String customEventData)	Sets the value of MatchmakingConfigurationProps.getCustomEventData()
QueuedMatchmakingConfigurationProps.Builder	description(String description)	Sets the value of MatchmakingConfigurationProps.getDescription()
QueuedMatchmakingConfigurationProps.Builder	gameProperties(List<? extends GameProperty> gameProperties)	Sets the value of QueuedMatchmakingConfigurationProps.getGameProperties()
QueuedMatchmakingConfigurationProps.Builder	gameSessionData(String gameSessionData)	Sets the value of QueuedMatchmakingConfigurationProps.getGameSessionData()
QueuedMatchmakingConfigurationProps.Builder	gameSessionQueues(List<? extends IGameSessionQueue> gameSessionQueues)	Sets the value of QueuedMatchmakingConfigurationProps.getGameSessionQueues()
QueuedMatchmakingConfigurationProps.Builder	manualBackfillMode(Boolean manualBackfillMode)	Sets the value of QueuedMatchmakingConfigurationProps.getManualBackfillMode()
QueuedMatchmakingConfigurationProps.Builder	matchmakingConfigurationName(String matchmakingConfigurationName)	Sets the value of MatchmakingConfigurationProps.getMatchmakingConfigurationName()
QueuedMatchmakingConfigurationProps.Builder	notificationTarget(ITopic notificationTarget)	Sets the value of MatchmakingConfigurationProps.getNotificationTarget()
QueuedMatchmakingConfigurationProps.Builder	requestTimeout(Duration requestTimeout)	Sets the value of MatchmakingConfigurationProps.getRequestTimeout()
QueuedMatchmakingConfigurationProps.Builder	requireAcceptance(Boolean requireAcceptance)	Sets the value of MatchmakingConfigurationProps.getRequireAcceptance()
QueuedMatchmakingConfigurationProps.Builder	ruleSet(IMatchmakingRuleSet ruleSet)	Sets the value of MatchmakingConfigurationProps.getRuleSet()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

gameSessionQueues

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder gameSessionQueues(List<? extends IGameSessionQueue> gameSessionQueues)

Sets the value of QueuedMatchmakingConfigurationProps.getGameSessionQueues()

Parameters:

gameSessionQueues - Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This parameter is required. Queues can be located in any Region.

Returns:

this

additionalPlayerCount

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder additionalPlayerCount(Number additionalPlayerCount)

Sets the value of QueuedMatchmakingConfigurationProps.getAdditionalPlayerCount()

Parameters:

additionalPlayerCount - 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.

Returns:

this

gameProperties

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder gameProperties(List<? extends GameProperty> gameProperties)

Sets the value of QueuedMatchmakingConfigurationProps.getGameProperties()

Parameters:

gameProperties - 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.

Returns:

this

gameSessionData

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder gameSessionData(String gameSessionData)

Sets the value of QueuedMatchmakingConfigurationProps.getGameSessionData()

Parameters:

gameSessionData - 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.

Returns:

this

manualBackfillMode

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder manualBackfillMode(Boolean manualBackfillMode)

Sets the value of QueuedMatchmakingConfigurationProps.getManualBackfillMode()

Parameters:

manualBackfillMode - 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.

Returns:

this

matchmakingConfigurationName

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder matchmakingConfigurationName(String matchmakingConfigurationName)

Sets the value of MatchmakingConfigurationProps.getMatchmakingConfigurationName()

Parameters:

matchmakingConfigurationName - A unique identifier for the matchmaking configuration. This parameter is required. This name is used to identify the configuration associated with a matchmaking request or ticket.

Returns:

this

ruleSet

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder ruleSet(IMatchmakingRuleSet ruleSet)

Sets the value of MatchmakingConfigurationProps.getRuleSet()

Parameters:

ruleSet - A matchmaking rule set to use with this configuration. This parameter is required. A matchmaking configuration can only use rule sets that are defined in the same Region.

Returns:

this

acceptanceTimeout

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder acceptanceTimeout(Duration acceptanceTimeout)

Sets the value of MatchmakingConfigurationProps.getAcceptanceTimeout()

Parameters:

acceptanceTimeout - The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

Returns:

this

customEventData

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder customEventData(String customEventData)

Sets the value of MatchmakingConfigurationProps.getCustomEventData()

Parameters:

customEventData - Information to add to all events related to the matchmaking configuration.

Returns:

this

description

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder description(String description)

Sets the value of MatchmakingConfigurationProps.getDescription()

Parameters:

description - A human-readable description of the matchmaking configuration.

Returns:

this

notificationTarget

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder notificationTarget(ITopic notificationTarget)

Sets the value of MatchmakingConfigurationProps.getNotificationTarget()

Parameters:

notificationTarget - An SNS topic ARN that is set up to receive matchmaking notifications.

Returns:

this

requestTimeout

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder requestTimeout(Duration requestTimeout)

Sets the value of MatchmakingConfigurationProps.getRequestTimeout()

Parameters:

requestTimeout - 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.

Returns:

this

requireAcceptance

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps.Builder requireAcceptance(Boolean requireAcceptance)

Sets the value of MatchmakingConfigurationProps.getRequireAcceptance()

Parameters:

requireAcceptance - 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.

Returns:

this

build

@Stability(Experimental)
public QueuedMatchmakingConfigurationProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<QueuedMatchmakingConfigurationProps>

Returns:

a new instance of QueuedMatchmakingConfigurationProps

Throws:

NullPointerException - if any required attribute was not provided