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

Interface IMatchmakingConfiguration

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IMatchmakingConfiguration.Jsii$Default
All Known Implementing Classes:
IMatchmakingConfiguration.Jsii$Proxy, MatchmakingConfigurationBase, QueuedMatchmakingConfiguration, StandaloneMatchmakingConfiguration
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:53.245Z") @Stability(Experimental) public interface IMatchmakingConfiguration extends software.amazon.jsii.JsiiSerializable, IResource
(experimental) Represents a Gamelift matchmaking configuration.

  • Method Details

    • getMatchmakingConfigurationArn

      @Stability(Experimental) @NotNull String getMatchmakingConfigurationArn()
      (experimental) The ARN of the matchmaking configuration.

    • getMatchmakingConfigurationName

      @Stability(Experimental) @NotNull String getMatchmakingConfigurationName()
      (experimental) The name of the matchmaking configuration.

    • getNotificationTarget

      @Stability(Experimental) @Nullable default ITopic getNotificationTarget()
      (experimental) The notification target for matchmaking events.

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Return the given named metric for this matchmaking configuration.

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName)
      (experimental) Return the given named metric for this matchmaking configuration.

      Parameters:
      metricName - This parameter is required.

    • metricCurrentTickets

      @Stability(Experimental) @NotNull Metric metricCurrentTickets(@Nullable MetricOptions props)
      (experimental) Matchmaking requests currently being processed or waiting to be processed.

      Parameters:
      props -

    • metricCurrentTickets

      @Stability(Experimental) @NotNull Metric metricCurrentTickets()
      (experimental) Matchmaking requests currently being processed or waiting to be processed.

    • metricMatchesAccepted

      @Stability(Experimental) @NotNull Metric metricMatchesAccepted(@Nullable MetricOptions props)
      (experimental) For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.

      Parameters:
      props -

    • metricMatchesAccepted

      @Stability(Experimental) @NotNull Metric metricMatchesAccepted()
      (experimental) For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.

    • metricMatchesCreated

      @Stability(Experimental) @NotNull Metric metricMatchesCreated(@Nullable MetricOptions props)
      (experimental) Potential matches that were created since the last report.

      Parameters:
      props -

    • metricMatchesCreated

      @Stability(Experimental) @NotNull Metric metricMatchesCreated()
      (experimental) Potential matches that were created since the last report.

    • metricMatchesPlaced

      @Stability(Experimental) @NotNull Metric metricMatchesPlaced(@Nullable MetricOptions props)
      (experimental) Matches that were successfully placed into a game session since the last report.

      Parameters:
      props -

    • metricMatchesPlaced

      @Stability(Experimental) @NotNull Metric metricMatchesPlaced()
      (experimental) Matches that were successfully placed into a game session since the last report.

    • metricMatchesRejected

      @Stability(Experimental) @NotNull Metric metricMatchesRejected(@Nullable MetricOptions props)
      (experimental) For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report.

      Parameters:
      props -

    • metricMatchesRejected

      @Stability(Experimental) @NotNull Metric metricMatchesRejected()
      (experimental) For matchmaking configurations that require acceptance, the potential matches that were rejected by at least one player since the last report.

    • metricPlayersStarted

      @Stability(Experimental) @NotNull Metric metricPlayersStarted(@Nullable MetricOptions props)
      (experimental) Players in matchmaking tickets that were added since the last report.

      Parameters:
      props -

    • metricPlayersStarted

      @Stability(Experimental) @NotNull Metric metricPlayersStarted()
      (experimental) Players in matchmaking tickets that were added since the last report.

    • metricTimeToMatch

      @Stability(Experimental) @NotNull Metric metricTimeToMatch(@Nullable MetricOptions props)
      (experimental) For matchmaking requests that were put into a potential match before the last report, the amount of time between ticket creation and potential match creation.

      Units: seconds

      Parameters:
      props -

    • metricTimeToMatch

      @Stability(Experimental) @NotNull Metric metricTimeToMatch()
      (experimental) For matchmaking requests that were put into a potential match before the last report, the amount of time between ticket creation and potential match creation.

      Units: seconds