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

Class StandaloneMatchmakingConfiguration.Builder

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

  • Method Details

    • create

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

    • matchmakingConfigurationName

      @Stability(Experimental) public StandaloneMatchmakingConfiguration.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 StandaloneMatchmakingConfiguration.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 StandaloneMatchmakingConfiguration.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 StandaloneMatchmakingConfiguration.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 StandaloneMatchmakingConfiguration.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 StandaloneMatchmakingConfiguration.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 StandaloneMatchmakingConfiguration.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 StandaloneMatchmakingConfiguration.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

    • build

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