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

Class QueuedMatchmakingConfiguration.Builder

java.lang.Object
software.amazon.awscdk.services.gamelift.alpha.QueuedMatchmakingConfiguration.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<QueuedMatchmakingConfiguration>
Enclosing class:
QueuedMatchmakingConfiguration
@Stability(Experimental) public static final class QueuedMatchmakingConfiguration.Builder extends Object implements software.amazon.jsii.Builder<QueuedMatchmakingConfiguration>
(experimental) A fluent builder for QueuedMatchmakingConfiguration.

  • Method Details

    • create

      @Stability(Experimental) public static QueuedMatchmakingConfiguration.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of QueuedMatchmakingConfiguration.Builder.

    • matchmakingConfigurationName

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder matchmakingConfigurationName(String matchmakingConfigurationName)
      (experimental) A unique identifier for the matchmaking configuration.

      This name is used to identify the configuration associated with a matchmaking request or ticket.

      Parameters:
      matchmakingConfigurationName - A unique identifier for the matchmaking configuration. This parameter is required.
      Returns:
      this

    • ruleSet

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder ruleSet(IMatchmakingRuleSet ruleSet)
      (experimental) A matchmaking rule set to use with this configuration.

      A matchmaking configuration can only use rule sets that are defined in the same Region.

      Parameters:
      ruleSet - A matchmaking rule set to use with this configuration. This parameter is required.
      Returns:
      this

    • acceptanceTimeout

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder acceptanceTimeout(Duration acceptanceTimeout)
      (experimental) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

      Default: 300 seconds

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

    • customEventData

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder customEventData(String customEventData)
      (experimental) Information to add to all events related to the matchmaking configuration.

      Default: no custom data added to events

      Parameters:
      customEventData - Information to add to all events related to the matchmaking configuration. This parameter is required.
      Returns:
      this

    • description

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder description(String description)
      (experimental) A human-readable description of the matchmaking configuration.

      Default: no description is provided

      Parameters:
      description - A human-readable description of the matchmaking configuration. This parameter is required.
      Returns:
      this

    • notificationTarget

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder notificationTarget(ITopic notificationTarget)
      (experimental) An SNS topic ARN that is set up to receive matchmaking notifications.

      Default: no notification target

      Parameters:
      notificationTarget - An SNS topic ARN that is set up to receive matchmaking notifications. This parameter is required.
      Returns:
      this
      See Also:

    • requestTimeout

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder requestTimeout(Duration requestTimeout)
      (experimental) 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.

      Default: 300 seconds

      Parameters:
      requestTimeout - The maximum duration, that a matchmaking ticket can remain in process before timing out. This parameter is required.
      Returns:
      this

    • requireAcceptance

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder requireAcceptance(Boolean requireAcceptance)
      (experimental) 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.

      Default: Acceptance is not required

      Parameters:
      requireAcceptance - A flag that determines whether a match that was created with this configuration must be accepted by the matched players. This parameter is required.
      Returns:
      this

    • gameSessionQueues

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder gameSessionQueues(List<? extends IGameSessionQueue> gameSessionQueues)
      (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.

      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.
      Returns:
      this

    • additionalPlayerCount

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder additionalPlayerCount(Number additionalPlayerCount)
      (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

      Parameters:
      additionalPlayerCount - The number of player slots in a match to keep open for future players. This parameter is required.
      Returns:
      this

    • gameProperties

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder gameProperties(List<? extends GameProperty> gameProperties)
      (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

      Parameters:
      gameProperties - A set of custom properties for a game session, formatted as key-value pairs. This parameter is required.
      Returns:
      this
      See Also:

    • gameSessionData

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder gameSessionData(String gameSessionData)
      (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

      Parameters:
      gameSessionData - A set of custom game session properties, formatted as a single string value. This parameter is required.
      Returns:
      this
      See Also:

    • manualBackfillMode

      @Stability(Experimental) public QueuedMatchmakingConfiguration.Builder manualBackfillMode(Boolean manualBackfillMode)
      (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

      Parameters:
      manualBackfillMode - The method used to backfill game sessions that are created with this matchmaking configuration. This parameter is required.
      Returns:
      this
      See Also:

    • build

      @Stability(Experimental) public QueuedMatchmakingConfiguration build()
      Specified by:
      build in interface software.amazon.jsii.Builder<QueuedMatchmakingConfiguration>
      Returns:
      a newly built instance of QueuedMatchmakingConfiguration.