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

Class GameSessionQueue

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.gamelift.alpha.GameSessionQueueBase
software.amazon.awscdk.services.gamelift.alpha.GameSessionQueue
All Implemented Interfaces:
IResource, IGameSessionQueue, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:49.999Z") @Stability(Experimental) public class GameSessionQueue extends GameSessionQueueBase
(experimental) The GameSessionQueue resource creates a placement queue that processes requests for new game sessions.

A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session. Queues can have destinations (GameLift fleets or gameSessionQueuees), which determine where the queue can place new game sessions. A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region.

Example: 

 BuildFleet fleet;
 Alias alias;
 GameSessionQueue queue = GameSessionQueue.Builder.create(this, "GameSessionQueue")
         .gameSessionQueueName("my-queue-name")
         .destinations(List.of(fleet))
         .build();
 queue.addDestination(alias);

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • GameSessionQueue

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

    • GameSessionQueue

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

    • GameSessionQueue

      @Stability(Experimental) public GameSessionQueue(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull GameSessionQueueProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromGameSessionQueueArn

      @Stability(Experimental) @NotNull public static IGameSessionQueue fromGameSessionQueueArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String gameSessionQueueArn)
      (experimental) Import an existing gameSessionQueue from its ARN.

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

    • fromGameSessionQueueAttributes

      @Stability(Experimental) @NotNull public static IGameSessionQueue fromGameSessionQueueAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull GameSessionQueueAttributes attrs)
      (experimental) Import an existing gameSessionQueue from its attributes.

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

    • fromGameSessionQueueName

      @Stability(Experimental) @NotNull public static IGameSessionQueue fromGameSessionQueueName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String gameSessionQueueName)
      (experimental) Import an existing gameSessionQueue from its name.

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

    • addDestination

      @Stability(Experimental) public void addDestination(@NotNull IGameSessionQueueDestination destination)
      (experimental) Adds a destination to fulfill requests for new game sessions.

      Parameters:
      destination - A destination to add. This parameter is required.

    • parseFilterConfiguration

      @Stability(Experimental) @Nullable protected CfnGameSessionQueue.FilterConfigurationProperty parseFilterConfiguration(@NotNull GameSessionQueueProps props)
      Parameters:
      props - This parameter is required.

    • parsePlayerLatencyPolicies

      @Stability(Experimental) @Nullable protected List<CfnGameSessionQueue.PlayerLatencyPolicyProperty> parsePlayerLatencyPolicies(@NotNull GameSessionQueueProps props)
      Parameters:
      props - This parameter is required.

    • parsePriorityConfiguration

      @Stability(Experimental) @Nullable protected CfnGameSessionQueue.PriorityConfigurationProperty parsePriorityConfiguration(@NotNull GameSessionQueueProps props)
      Parameters:
      props - This parameter is required.

    • getGameSessionQueueArn

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

    • getGameSessionQueueName

      @Stability(Experimental) @NotNull public String getGameSessionQueueName()
      (experimental) The Identifier of the gameSessionQueue.
      Specified by:
      getGameSessionQueueName in interface IGameSessionQueue
      Specified by:
      getGameSessionQueueName in class GameSessionQueueBase