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

Interface IMatchmakingConfiguration.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IMatchmakingConfiguration, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IMatchmakingConfiguration.Jsii$Proxy
Enclosing interface:
IMatchmakingConfiguration
@Internal public static interface IMatchmakingConfiguration.Jsii$Default extends IMatchmakingConfiguration, IResource.Jsii$Default
Internal default implementation for IMatchmakingConfiguration.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getMatchmakingConfigurationArn

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

    • getMatchmakingConfigurationName

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

    • getNotificationTarget

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

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • metric

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

    • metricCurrentTickets

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

      Specified by:
      metricCurrentTickets in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricMatchesAccepted

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

    • metricMatchesCreated

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

      Specified by:
      metricMatchesCreated in interface IMatchmakingConfiguration
      Parameters:
      props -

    • metricMatchesPlaced

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

    • metricMatchesRejected

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

    • metricPlayersStarted

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

    • metricTimeToMatch

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