Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. gamelift
  5. getGameSessionQueue

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.getGameSessionQueue

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.

Using getGameSessionQueue

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGameSessionQueue(args: GetGameSessionQueueArgs, opts?: InvokeOptions): Promise<GetGameSessionQueueResult>
function getGameSessionQueueOutput(args: GetGameSessionQueueOutputArgs, opts?: InvokeOptions): Output<GetGameSessionQueueResult>
Copy
def get_game_session_queue(name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetGameSessionQueueResult
def get_game_session_queue_output(name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetGameSessionQueueResult]
Copy
func LookupGameSessionQueue(ctx *Context, args *LookupGameSessionQueueArgs, opts ...InvokeOption) (*LookupGameSessionQueueResult, error)
func LookupGameSessionQueueOutput(ctx *Context, args *LookupGameSessionQueueOutputArgs, opts ...InvokeOption) LookupGameSessionQueueResultOutput
Copy

> Note: This function is named LookupGameSessionQueue in the Go SDK.

public static class GetGameSessionQueue 
{
    public static Task<GetGameSessionQueueResult> InvokeAsync(GetGameSessionQueueArgs args, InvokeOptions? opts = null)
    public static Output<GetGameSessionQueueResult> Invoke(GetGameSessionQueueInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGameSessionQueueResult> getGameSessionQueue(GetGameSessionQueueArgs args, InvokeOptions options)
public static Output<GetGameSessionQueueResult> getGameSessionQueue(GetGameSessionQueueArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:gamelift:getGameSessionQueue
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
Name This property is required. string
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
name This property is required. String
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
name This property is required. string
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
name This property is required. str
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
name This property is required. String
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.

getGameSessionQueue Result

The following output properties are available:

Arn string
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
CustomEventData string
Information that is added to all events that are related to this game session queue.
Destinations List<Pulumi.AwsNative.GameLift.Outputs.GameSessionQueueDestination>
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
FilterConfiguration Pulumi.AwsNative.GameLift.Outputs.GameSessionQueueFilterConfiguration
A list of locations where a queue is allowed to place new game sessions.
NotificationTarget string
An SNS topic ARN that is set up to receive game session placement notifications.
PlayerLatencyPolicies List<Pulumi.AwsNative.GameLift.Outputs.GameSessionQueuePlayerLatencyPolicy>
A set of policies that act as a sliding cap on player latency.
PriorityConfiguration Pulumi.AwsNative.GameLift.Outputs.GameSessionQueuePriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
TimeoutInSeconds int
The maximum time, in seconds, that a new game session placement request remains in the queue.
Arn string
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
CustomEventData string
Information that is added to all events that are related to this game session queue.
Destinations []GameSessionQueueDestination
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
FilterConfiguration GameSessionQueueFilterConfiguration
A list of locations where a queue is allowed to place new game sessions.
NotificationTarget string
An SNS topic ARN that is set up to receive game session placement notifications.
PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicy
A set of policies that act as a sliding cap on player latency.
PriorityConfiguration GameSessionQueuePriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.
Tags Tag
An array of key-value pairs to apply to this resource.
TimeoutInSeconds int
The maximum time, in seconds, that a new game session placement request remains in the queue.
arn String
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
customEventData String
Information that is added to all events that are related to this game session queue.
destinations List<GameSessionQueueDestination>
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
filterConfiguration GameSessionQueueFilterConfiguration
A list of locations where a queue is allowed to place new game sessions.
notificationTarget String
An SNS topic ARN that is set up to receive game session placement notifications.
playerLatencyPolicies List<GameSessionQueuePlayerLatencyPolicy>
A set of policies that act as a sliding cap on player latency.
priorityConfiguration GameSessionQueuePriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.
tags List<Tag>
An array of key-value pairs to apply to this resource.
timeoutInSeconds Integer
The maximum time, in seconds, that a new game session placement request remains in the queue.
arn string
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
customEventData string
Information that is added to all events that are related to this game session queue.
destinations GameSessionQueueDestination[]
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
filterConfiguration GameSessionQueueFilterConfiguration
A list of locations where a queue is allowed to place new game sessions.
notificationTarget string
An SNS topic ARN that is set up to receive game session placement notifications.
playerLatencyPolicies GameSessionQueuePlayerLatencyPolicy[]
A set of policies that act as a sliding cap on player latency.
priorityConfiguration GameSessionQueuePriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.
tags Tag[]
An array of key-value pairs to apply to this resource.
timeoutInSeconds number
The maximum time, in seconds, that a new game session placement request remains in the queue.
arn str
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
custom_event_data str
Information that is added to all events that are related to this game session queue.
destinations Sequence[GameSessionQueueDestination]
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
filter_configuration GameSessionQueueFilterConfiguration
A list of locations where a queue is allowed to place new game sessions.
notification_target str
An SNS topic ARN that is set up to receive game session placement notifications.
player_latency_policies Sequence[GameSessionQueuePlayerLatencyPolicy]
A set of policies that act as a sliding cap on player latency.
priority_configuration GameSessionQueuePriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
timeout_in_seconds int
The maximum time, in seconds, that a new game session placement request remains in the queue.
arn String
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
customEventData String
Information that is added to all events that are related to this game session queue.
destinations List<Property Map>
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
filterConfiguration Property Map
A list of locations where a queue is allowed to place new game sessions.
notificationTarget String
An SNS topic ARN that is set up to receive game session placement notifications.
playerLatencyPolicies List<Property Map>
A set of policies that act as a sliding cap on player latency.
priorityConfiguration Property Map
Custom settings to use when prioritizing destinations and locations for game session placements.
tags List<Property Map>
An array of key-value pairs to apply to this resource.
timeoutInSeconds Number
The maximum time, in seconds, that a new game session placement request remains in the queue.

Supporting Types

GameSessionQueueDestination

DestinationArn string
The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
DestinationArn string
The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
destinationArn String
The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
destinationArn string
The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
destination_arn str
The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
destinationArn String
The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.

GameSessionQueueFilterConfiguration

AllowedLocations List<string>
A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
AllowedLocations []string
A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
allowedLocations List<String>
A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
allowedLocations string[]
A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
allowed_locations Sequence[str]
A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
allowedLocations List<String>
A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .

GameSessionQueuePlayerLatencyPolicy

MaximumIndividualPlayerLatencyMilliseconds int
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
PolicyDurationSeconds int
The length of time, in seconds, that the policy is enforced while placing a new game session.
MaximumIndividualPlayerLatencyMilliseconds int
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
PolicyDurationSeconds int
The length of time, in seconds, that the policy is enforced while placing a new game session.
maximumIndividualPlayerLatencyMilliseconds Integer
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
policyDurationSeconds Integer
The length of time, in seconds, that the policy is enforced while placing a new game session.
maximumIndividualPlayerLatencyMilliseconds number
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
policyDurationSeconds number
The length of time, in seconds, that the policy is enforced while placing a new game session.
maximum_individual_player_latency_milliseconds int
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
policy_duration_seconds int
The length of time, in seconds, that the policy is enforced while placing a new game session.
maximumIndividualPlayerLatencyMilliseconds Number
The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
policyDurationSeconds Number
The length of time, in seconds, that the policy is enforced while placing a new game session.

GameSessionQueuePriorityConfiguration

LocationOrder List<string>
The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
PriorityOrder List<Pulumi.AwsNative.GameLift.GameSessionQueuePriorityOrderItem>
A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
  • COST -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).
  • DESTINATION -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
  • LOCATION -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .
LocationOrder []string
The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
PriorityOrder []GameSessionQueuePriorityOrderItem
A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
  • COST -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).
  • DESTINATION -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
  • LOCATION -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .
locationOrder List<String>
The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
priorityOrder List<GameSessionQueuePriorityOrderItem>
A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
  • COST -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).
  • DESTINATION -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
  • LOCATION -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .
locationOrder string[]
The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
priorityOrder GameSessionQueuePriorityOrderItem[]
A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
  • COST -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).
  • DESTINATION -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
  • LOCATION -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .
location_order Sequence[str]
The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
priority_order Sequence[GameSessionQueuePriorityOrderItem]
A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
  • COST -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).
  • DESTINATION -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
  • LOCATION -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .
locationOrder List<String>
The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations can include AWS Region codes (such as us-west-2 ), local zones, and custom locations (for Anywhere fleets). Each location must be listed only once. For details, see Amazon GameLift Servers service locations.
priorityOrder List<"LATENCY" | "COST" | "DESTINATION" | "LOCATION">
A custom sequence to use when prioritizing where to place new game sessions. Each priority type is listed once.

  • LATENCY -- Amazon GameLift Servers prioritizes locations where the average player latency is lowest. Player latency data is provided in each game session placement request.
  • COST -- Amazon GameLift Servers prioritizes queue destinations with the lowest current hosting costs. Cost is evaluated based on the destination's location, instance type, and fleet type (Spot or On-Demand).
  • DESTINATION -- Amazon GameLift Servers prioritizes based on the list order of destinations in the queue configuration.
  • LOCATION -- Amazon GameLift Servers prioritizes based on the provided order of locations, as defined in LocationOrder .

GameSessionQueuePriorityOrderItem

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native