Package software.amazon.awscdk.services.gamelift

Class CfnGameSessionQueue

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gamelift.CfnGameSessionQueue
All Implemented Interfaces:
IInspectable, ITaggable, IGameSessionQueueRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:40.647Z") @Stability(Stable) public class CfnGameSessionQueue extends CfnResource implements IInspectable, IGameSessionQueueRef, ITaggable
The AWS::GameLift::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 aliases), 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: 

 // 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.*;
 CfnGameSessionQueue cfnGameSessionQueue = CfnGameSessionQueue.Builder.create(this, "MyCfnGameSessionQueue")
         .name("name")
         // the properties below are optional
         .customEventData("customEventData")
         .destinations(List.of(DestinationProperty.builder()
                 .destinationArn("destinationArn")
                 .build()))
         .filterConfiguration(FilterConfigurationProperty.builder()
                 .allowedLocations(List.of("allowedLocations"))
                 .build())
         .notificationTarget("notificationTarget")
         .playerLatencyPolicies(List.of(PlayerLatencyPolicyProperty.builder()
                 .maximumIndividualPlayerLatencyMilliseconds(123)
                 .policyDurationSeconds(123)
                 .build()))
         .priorityConfiguration(PriorityConfigurationProperty.builder()
                 .locationOrder(List.of("locationOrder"))
                 .priorityOrder(List.of("priorityOrder"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutInSeconds(123)
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGameSessionQueue

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

    • CfnGameSessionQueue

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

    • CfnGameSessionQueue

      @Stability(Stable) public CfnGameSessionQueue(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGameSessionQueueProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromGameSessionQueueArn

      @Stability(Stable) @NotNull public static IGameSessionQueueRef fromGameSessionQueueArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IGameSessionQueueRef from an ARN.

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

    • fromGameSessionQueueName

      @Stability(Stable) @NotNull public static IGameSessionQueueRef fromGameSessionQueueName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String gameSessionQueueName)
      Creates a new IGameSessionQueueRef from a gameSessionQueueName.

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

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The unique Amazon Resource Name (ARN) for the GameSessionQueue .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      A descriptive label that is associated with a game session queue.

      Names are unique within each Region.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGameSessionQueueRef

      @Stability(Stable) @NotNull public GameSessionQueueReference getGameSessionQueueRef()
      A reference to a GameSessionQueue resource.
      Specified by:
      getGameSessionQueueRef in interface IGameSessionQueueRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      A descriptive label that is associated with game session queue.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A descriptive label that is associated with game session queue.

    • getCustomEventData

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

    • setCustomEventData

      @Stability(Stable) public void setCustomEventData(@Nullable String value)
      Information to be added to all events that are related to this game session queue.

    • getDestinations

      @Stability(Stable) @Nullable public Object getDestinations()
      A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGameSessionQueue.DestinationProperty>

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable IResolvable value)
      A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

    • setDestinations

      @Stability(Stable) public void setDestinations(@Nullable List<Object> value)
      A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

    • getFilterConfiguration

      @Stability(Stable) @Nullable public Object getFilterConfiguration()
      A list of locations where a queue is allowed to place new game sessions.

      Returns union: either IResolvable or CfnGameSessionQueue.FilterConfigurationProperty

    • setFilterConfiguration

      @Stability(Stable) public void setFilterConfiguration(@Nullable IResolvable value)
      A list of locations where a queue is allowed to place new game sessions.

    • setFilterConfiguration

      @Stability(Stable) public void setFilterConfiguration(@Nullable CfnGameSessionQueue.FilterConfigurationProperty value)
      A list of locations where a queue is allowed to place new game sessions.

    • getNotificationTarget

      @Stability(Stable) @Nullable public String getNotificationTarget()
      An SNS topic ARN that is set up to receive game session placement notifications.

    • setNotificationTarget

      @Stability(Stable) public void setNotificationTarget(@Nullable String value)
      An SNS topic ARN that is set up to receive game session placement notifications.

    • getPlayerLatencyPolicies

      @Stability(Stable) @Nullable public Object getPlayerLatencyPolicies()
      A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGameSessionQueue.PlayerLatencyPolicyProperty>

    • setPlayerLatencyPolicies

      @Stability(Stable) public void setPlayerLatencyPolicies(@Nullable IResolvable value)
      A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.

    • setPlayerLatencyPolicies

      @Stability(Stable) public void setPlayerLatencyPolicies(@Nullable List<Object> value)
      A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.

    • getPriorityConfiguration

      @Stability(Stable) @Nullable public Object getPriorityConfiguration()
      Custom settings to use when prioritizing destinations and locations for game session placements.

      Returns union: either IResolvable or CfnGameSessionQueue.PriorityConfigurationProperty

    • setPriorityConfiguration

      @Stability(Stable) public void setPriorityConfiguration(@Nullable IResolvable value)
      Custom settings to use when prioritizing destinations and locations for game session placements.

    • setPriorityConfiguration

      @Stability(Stable) public void setPriorityConfiguration(@Nullable CfnGameSessionQueue.PriorityConfigurationProperty value)
      Custom settings to use when prioritizing destinations and locations for game session placements.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of labels to assign to the new game session queue resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of labels to assign to the new game session queue resource.

    • getTimeoutInSeconds

      @Stability(Stable) @Nullable public Number getTimeoutInSeconds()
      The maximum time, in seconds, that a new game session placement request remains in the queue.

    • setTimeoutInSeconds

      @Stability(Stable) public void setTimeoutInSeconds(@Nullable Number value)
      The maximum time, in seconds, that a new game session placement request remains in the queue.