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

Interface IGameSessionQueue.Jsii$Default

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

  • 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

    • getGameSessionQueueArn

      @Stability(Experimental) @NotNull default String getGameSessionQueueArn()
      (experimental) The ARN of the gameSessionQueue.
      Specified by:
      getGameSessionQueueArn in interface IGameSessionQueue

    • getGameSessionQueueName

      @Stability(Experimental) @NotNull default String getGameSessionQueueName()
      (experimental) The Name of the gameSessionQueue.
      Specified by:
      getGameSessionQueueName in interface IGameSessionQueue

    • 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 fleet.

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

    • metricAverageWaitTime

      @Stability(Experimental) @NotNull default Metric metricAverageWaitTime(@Nullable MetricOptions props)
      (experimental) Average amount of time that game session placement requests in the queue with status PENDING have been waiting to be fulfilled.

      Specified by:
      metricAverageWaitTime in interface IGameSessionQueue
      Parameters:
      props -

    • metricPlacementsCanceled

      @Stability(Experimental) @NotNull default Metric metricPlacementsCanceled(@Nullable MetricOptions props)
      (experimental) Game session placement requests that were canceled before timing out since the last report.

      Specified by:
      metricPlacementsCanceled in interface IGameSessionQueue
      Parameters:
      props -

    • metricPlacementsFailed

      @Stability(Experimental) @NotNull default Metric metricPlacementsFailed(@Nullable MetricOptions props)
      (experimental) Game session placement requests that failed for any reason since the last report.

      Specified by:
      metricPlacementsFailed in interface IGameSessionQueue
      Parameters:
      props -

    • metricPlacementsStarted

      @Stability(Experimental) @NotNull default Metric metricPlacementsStarted(@Nullable MetricOptions props)
      (experimental) New game session placement requests that were added to the queue since the last report.

      Specified by:
      metricPlacementsStarted in interface IGameSessionQueue
      Parameters:
      props -

    • metricPlacementsSucceeded

      @Stability(Experimental) @NotNull default Metric metricPlacementsSucceeded(@Nullable MetricOptions props)
      (experimental) Game session placement requests that resulted in a new game session since the last report.

      Specified by:
      metricPlacementsSucceeded in interface IGameSessionQueue
      Parameters:
      props -

    • metricPlacementsTimedOut

      @Stability(Experimental) @NotNull default Metric metricPlacementsTimedOut(@Nullable MetricOptions props)
      (experimental) Game session placement requests that reached the queue's timeout limit without being fulfilled since the last report.

      Specified by:
      metricPlacementsTimedOut in interface IGameSessionQueue
      Parameters:
      props -