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

Interface GameSessionQueueProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
GameSessionQueueProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:15.687Z") @Stability(Experimental) public interface GameSessionQueueProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for a new Fleet gameSessionQueue.

Example: 

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

  • Method Details

    • getDestinations

      @Stability(Experimental) @NotNull List<IGameSessionQueueDestination> getDestinations()
      (experimental) A list of fleets and/or fleet alias that can be used to fulfill game session placement requests in the queue.

      Destinations are listed in order of placement preference.

    • getGameSessionQueueName

      @Stability(Experimental) @NotNull String getGameSessionQueueName()
      (experimental) Name of this gameSessionQueue.

    • getAllowedLocations

      @Stability(Experimental) @Nullable default List<String> getAllowedLocations()
      (experimental) A list of locations where a queue is allowed to place new game sessions.

      Locations are specified in the form of AWS Region codes, such as us-west-2.

      For queues that have multi-location fleets, you can use a filter configuration allow placement with some, but not all of these locations.

      Default: game sessions can be placed in any queue location

    • getCustomEventData

      @Stability(Experimental) @Nullable default String getCustomEventData()
      (experimental) Information to be added to all events that are related to this game session queue.

      Default: no customer event data

    • getNotificationTarget

      @Stability(Experimental) @Nullable default ITopic getNotificationTarget()
      (experimental) An SNS topic is set up to receive game session placement notifications.

      Default: no notification

      See Also:

    • getPlayerLatencyPolicies

      @Stability(Experimental) @Nullable default List<PlayerLatencyPolicy> getPlayerLatencyPolicies()
      (experimental) A set of policies that act as a sliding cap on player latency.

      FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.

      Default: no player latency policy

    • getPriorityConfiguration

      @Stability(Experimental) @Nullable default PriorityConfiguration getPriorityConfiguration()
      (experimental) Custom settings to use when prioritizing destinations and locations for game session placements.

      This configuration replaces the FleetIQ default prioritization process.

      Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.

      Default: no priority configuration

    • getTimeout

      @Stability(Experimental) @Nullable default Duration getTimeout()
      (experimental) The maximum time, that a new game session placement request remains in the queue.

      When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

      Default: 50 seconds

    • builder

      @Stability(Experimental) static GameSessionQueueProps.Builder builder()
      Returns:
      a GameSessionQueueProps.Builder of GameSessionQueueProps