Interface MatchmakingConfigurationProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
QueuedMatchmakingConfigurationProps, StandaloneMatchmakingConfigurationProps
All Known Implementing Classes:
MatchmakingConfigurationProps.Jsii$Proxy, QueuedMatchmakingConfigurationProps.Jsii$Proxy, StandaloneMatchmakingConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-27T16:51:07.241Z") @Stability(Experimental) public interface MatchmakingConfigurationProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for a new Gamelift matchmaking configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.alpha.*;
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.sns.*;
 MatchmakingRuleSet matchmakingRuleSet;
 Topic topic;
 MatchmakingConfigurationProps matchmakingConfigurationProps = MatchmakingConfigurationProps.builder()
         .matchmakingConfigurationName("matchmakingConfigurationName")
         .ruleSet(matchmakingRuleSet)
         // the properties below are optional
         .acceptanceTimeout(Duration.minutes(30))
         .customEventData("customEventData")
         .description("description")
         .notificationTarget(topic)
         .requestTimeout(Duration.minutes(30))
         .requireAcceptance(false)
         .build();
 
  • Method Details

    • getMatchmakingConfigurationName

      @Stability(Experimental) @NotNull String getMatchmakingConfigurationName()
      (experimental) A unique identifier for the matchmaking configuration.

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

    • getRuleSet

      @Stability(Experimental) @NotNull IMatchmakingRuleSet getRuleSet()
      (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.

    • getAcceptanceTimeout

      @Stability(Experimental) @Nullable default Duration getAcceptanceTimeout()
      (experimental) The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

      Default: 300 seconds

    • getCustomEventData

      @Stability(Experimental) @Nullable default String getCustomEventData()
      (experimental) Information to add to all events related to the matchmaking configuration.

      Default: no custom data added to events

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) A human-readable description of the matchmaking configuration.

      Default: no description is provided

    • getNotificationTarget

      @Stability(Experimental) @Nullable default ITopic getNotificationTarget()
      (experimental) An SNS topic ARN that is set up to receive matchmaking notifications.

      Default: no notification target

      See Also:
    • getRequestTimeout

      @Stability(Experimental) @Nullable default Duration getRequestTimeout()
      (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

    • getRequireAcceptance

      @Stability(Experimental) @Nullable default Boolean getRequireAcceptance()
      (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

    • builder

      @Stability(Experimental) static MatchmakingConfigurationProps.Builder builder()
      Returns:
      a MatchmakingConfigurationProps.Builder of MatchmakingConfigurationProps