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

Class MatchmakingConfigurationBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.gamelift.alpha.MatchmakingConfigurationBase
All Implemented Interfaces:
IResource, IMatchmakingConfiguration, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
QueuedMatchmakingConfiguration, StandaloneMatchmakingConfiguration
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:53.262Z") @Stability(Experimental) public abstract class MatchmakingConfigurationBase extends Resource implements IMatchmakingConfiguration
(experimental) Base class for new and imported 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.services.sns.*;
 Topic topic;
 IMatchmakingConfiguration matchmakingConfigurationBase = MatchmakingConfigurationBase.fromMatchmakingConfigurationAttributes(this, "MyMatchmakingConfigurationBase", MatchmakingConfigurationAttributes.builder()
         .matchmakingConfigurationArn("matchmakingConfigurationArn")
         .matchmakingConfigurationName("matchmakingConfigurationName")
         .notificationTarget(topic)
         .build());

  • Constructor Details

    • MatchmakingConfigurationBase

      protected MatchmakingConfigurationBase(software.amazon.jsii.JsiiObjectRef objRef)

    • MatchmakingConfigurationBase

      protected MatchmakingConfigurationBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • MatchmakingConfigurationBase

      @Stability(Stable) protected MatchmakingConfigurationBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • MatchmakingConfigurationBase

      @Stability(Stable) protected MatchmakingConfigurationBase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • fromMatchmakingConfigurationAttributes

      @Stability(Experimental) @NotNull public static IMatchmakingConfiguration fromMatchmakingConfigurationAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull MatchmakingConfigurationAttributes attrs)
      (experimental) Import an existing matchmaking configuration from its attributes.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • metric

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

      Specified by:
      metric in interface IMatchmakingConfiguration
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Specified by:
      metric in interface IMatchmakingConfiguration
      Parameters:
      metricName - This parameter is required.

    • metricCurrentTickets

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

      Specified by:
      metricCurrentTickets in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricCurrentTickets

      @Stability(Experimental) @NotNull public Metric metricCurrentTickets()
      (experimental) Matchmaking requests currently being processed or waiting to be processed.
      Specified by:
      metricCurrentTickets in interface IMatchmakingConfiguration

    • metricMatchesAccepted

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

      Specified by:
      metricMatchesAccepted in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricMatchesAccepted

      @Stability(Experimental) @NotNull public Metric metricMatchesAccepted()
      (experimental) For matchmaking configurations that require acceptance, the potential matches that were accepted since the last report.
      Specified by:
      metricMatchesAccepted in interface IMatchmakingConfiguration

    • metricMatchesCreated

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

      Specified by:
      metricMatchesCreated in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricMatchesCreated

      @Stability(Experimental) @NotNull public Metric metricMatchesCreated()
      (experimental) Potential matches that were created since the last report.
      Specified by:
      metricMatchesCreated in interface IMatchmakingConfiguration

    • metricMatchesPlaced

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

      Specified by:
      metricMatchesPlaced in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricMatchesPlaced

      @Stability(Experimental) @NotNull public Metric metricMatchesPlaced()
      (experimental) Matches that were successfully placed into a game session since the last report.
      Specified by:
      metricMatchesPlaced in interface IMatchmakingConfiguration

    • metricMatchesRejected

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

      Specified by:
      metricMatchesRejected in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricMatchesRejected

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

    • metricPlayersStarted

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

      Specified by:
      metricPlayersStarted in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricPlayersStarted

      @Stability(Experimental) @NotNull public Metric metricPlayersStarted()
      (experimental) Players in matchmaking tickets that were added since the last report.
      Specified by:
      metricPlayersStarted in interface IMatchmakingConfiguration

    • metricTimeToMatch

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

      Specified by:
      metricTimeToMatch in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricTimeToMatch

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

      Specified by:
      metricTimeToMatch in interface IMatchmakingConfiguration

    • getMatchmakingConfigurationArn

      @Stability(Experimental) @NotNull public abstract String getMatchmakingConfigurationArn()
      (experimental) The ARN of the matchmaking configuration.
      Specified by:
      getMatchmakingConfigurationArn in interface IMatchmakingConfiguration

    • getMatchmakingConfigurationName

      @Stability(Experimental) @NotNull public abstract String getMatchmakingConfigurationName()
      (experimental) The Identifier of the matchmaking configuration.
      Specified by:
      getMatchmakingConfigurationName in interface IMatchmakingConfiguration

    • getNotificationTarget

      @Stability(Experimental) @Nullable public abstract ITopic getNotificationTarget()
      (experimental) The notification target for matchmaking events.
      Specified by:
      getNotificationTarget in interface IMatchmakingConfiguration