We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
aws-native.gamelift.getGameSessionQueue
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
AWS Cloud Control v1.0.1 published on Tuesday, Oct 1, 2024 by Pulumi
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>
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]
func LookupGameSessionQueue(ctx *Context, args *LookupGameSessionQueueArgs, opts ...InvokeOption) (*LookupGameSessionQueueResult, error)
func LookupGameSessionQueueOutput(ctx *Context, args *LookupGameSessionQueueOutputArgs, opts ...InvokeOption) LookupGameSessionQueueResultOutput
> 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)
}
public static CompletableFuture<GetGameSessionQueueResult> getGameSessionQueue(GetGameSessionQueueArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:gamelift:getGameSessionQueue
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
- Name string
- A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
- name String
- A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
- name string
- A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
- name str
- A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
- name 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.
- Custom
Event stringData - Information that is added to all events that are related to this game session queue.
- Destinations
List<Pulumi.
Aws Native. Game Lift. Outputs. Game Session Queue Destination> - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
- Filter
Configuration Pulumi.Aws Native. Game Lift. Outputs. Game Session Queue Filter Configuration - A list of locations where a queue is allowed to place new game sessions.
- Notification
Target string - An SNS topic ARN that is set up to receive game session placement notifications.
- Player
Latency List<Pulumi.Policies Aws Native. Game Lift. Outputs. Game Session Queue Player Latency Policy> - A set of policies that act as a sliding cap on player latency.
- Priority
Configuration Pulumi.Aws Native. Game Lift. Outputs. Game Session Queue Priority Configuration - Custom settings to use when prioritizing destinations and locations for game session placements.
- List<Pulumi.
Aws Native. Outputs. Tag> - An array of key-value pairs to apply to this resource.
- Timeout
In intSeconds - 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.
- Custom
Event stringData - Information that is added to all events that are related to this game session queue.
- Destinations
[]Game
Session Queue Destination - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
- Filter
Configuration GameSession Queue Filter Configuration - A list of locations where a queue is allowed to place new game sessions.
- Notification
Target string - An SNS topic ARN that is set up to receive game session placement notifications.
- Player
Latency []GamePolicies Session Queue Player Latency Policy - A set of policies that act as a sliding cap on player latency.
- Priority
Configuration GameSession Queue Priority Configuration - Custom settings to use when prioritizing destinations and locations for game session placements.
- Tag
- An array of key-value pairs to apply to this resource.
- Timeout
In intSeconds - 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.
- custom
Event StringData - Information that is added to all events that are related to this game session queue.
- destinations
List<Game
Session Queue Destination> - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
- filter
Configuration GameSession Queue Filter Configuration - A list of locations where a queue is allowed to place new game sessions.
- notification
Target String - An SNS topic ARN that is set up to receive game session placement notifications.
- player
Latency List<GamePolicies Session Queue Player Latency Policy> - A set of policies that act as a sliding cap on player latency.
- priority
Configuration GameSession Queue Priority Configuration - Custom settings to use when prioritizing destinations and locations for game session placements.
- List<Tag>
- An array of key-value pairs to apply to this resource.
- timeout
In IntegerSeconds - 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.
- custom
Event stringData - Information that is added to all events that are related to this game session queue.
- destinations
Game
Session Queue Destination[] - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
- filter
Configuration GameSession Queue Filter Configuration - A list of locations where a queue is allowed to place new game sessions.
- notification
Target string - An SNS topic ARN that is set up to receive game session placement notifications.
- player
Latency GamePolicies Session Queue Player Latency Policy[] - A set of policies that act as a sliding cap on player latency.
- priority
Configuration GameSession Queue Priority Configuration - Custom settings to use when prioritizing destinations and locations for game session placements.
- Tag[]
- An array of key-value pairs to apply to this resource.
- timeout
In numberSeconds - 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_ strdata - Information that is added to all events that are related to this game session queue.
- destinations
Sequence[Game
Session Queue Destination] - A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
- filter_
configuration GameSession Queue Filter Configuration - 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_ Sequence[Gamepolicies Session Queue Player Latency Policy] - A set of policies that act as a sliding cap on player latency.
- priority_
configuration GameSession Queue Priority Configuration - Custom settings to use when prioritizing destinations and locations for game session placements.
- Sequence[root_Tag]
- An array of key-value pairs to apply to this resource.
- timeout_
in_ intseconds - 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.
- custom
Event StringData - 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.
- filter
Configuration Property Map - A list of locations where a queue is allowed to place new game sessions.
- notification
Target String - An SNS topic ARN that is set up to receive game session placement notifications.
- player
Latency List<Property Map>Policies - A set of policies that act as a sliding cap on player latency.
- priority
Configuration Property Map - Custom settings to use when prioritizing destinations and locations for game session placements.
- List<Property Map>
- An array of key-value pairs to apply to this resource.
- timeout
In NumberSeconds - The maximum time, in seconds, that a new game session placement request remains in the queue.
Supporting Types
GameSessionQueueDestination
- Destination
Arn 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 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 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 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.
- destination
Arn 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
- Allowed
Locations List<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 []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 List<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 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
.
- allowed
Locations 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
- Maximum
Individual intPlayer Latency Milliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
- Policy
Duration intSeconds - The length of time, in seconds, that the policy is enforced while placing a new game session.
- Maximum
Individual intPlayer Latency Milliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
- Policy
Duration intSeconds - The length of time, in seconds, that the policy is enforced while placing a new game session.
- maximum
Individual IntegerPlayer Latency Milliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
- policy
Duration IntegerSeconds - The length of time, in seconds, that the policy is enforced while placing a new game session.
- maximum
Individual numberPlayer Latency Milliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
- policy
Duration numberSeconds - The length of time, in seconds, that the policy is enforced while placing a new game session.
- maximum_
individual_ intplayer_ latency_ milliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
- policy_
duration_ intseconds - The length of time, in seconds, that the policy is enforced while placing a new game session.
- maximum
Individual NumberPlayer Latency Milliseconds - The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
- policy
Duration NumberSeconds - The length of time, in seconds, that the policy is enforced while placing a new game session.
GameSessionQueuePriorityConfiguration
- Location
Order List<string> - The prioritization order to use for fleet locations, when the
PriorityOrder
property includesLOCATION
. Locations are identified by AWS Region codes such asus-west-2
. Each location can only be listed once. - Priority
Order List<Pulumi.Aws Native. Game Lift. Game Session Queue Priority Order Item> - The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
LATENCY
-- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.COST
-- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.DESTINATION
-- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.LOCATION
-- FleetIQ prioritizes based on the provided order of locations, as defined inLocationOrder
.
- Location
Order []string - The prioritization order to use for fleet locations, when the
PriorityOrder
property includesLOCATION
. Locations are identified by AWS Region codes such asus-west-2
. Each location can only be listed once. - Priority
Order []GameSession Queue Priority Order Item - The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
LATENCY
-- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.COST
-- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.DESTINATION
-- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.LOCATION
-- FleetIQ prioritizes based on the provided order of locations, as defined inLocationOrder
.
- location
Order List<String> - The prioritization order to use for fleet locations, when the
PriorityOrder
property includesLOCATION
. Locations are identified by AWS Region codes such asus-west-2
. Each location can only be listed once. - priority
Order List<GameSession Queue Priority Order Item> - The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
LATENCY
-- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.COST
-- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.DESTINATION
-- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.LOCATION
-- FleetIQ prioritizes based on the provided order of locations, as defined inLocationOrder
.
- location
Order string[] - The prioritization order to use for fleet locations, when the
PriorityOrder
property includesLOCATION
. Locations are identified by AWS Region codes such asus-west-2
. Each location can only be listed once. - priority
Order GameSession Queue Priority Order Item[] - The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
LATENCY
-- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.COST
-- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.DESTINATION
-- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.LOCATION
-- FleetIQ prioritizes based on the provided order of locations, as defined inLocationOrder
.
- location_
order Sequence[str] - The prioritization order to use for fleet locations, when the
PriorityOrder
property includesLOCATION
. Locations are identified by AWS Region codes such asus-west-2
. Each location can only be listed once. - priority_
order Sequence[GameSession Queue Priority Order Item] - The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
LATENCY
-- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.COST
-- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.DESTINATION
-- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.LOCATION
-- FleetIQ prioritizes based on the provided order of locations, as defined inLocationOrder
.
- location
Order List<String> - The prioritization order to use for fleet locations, when the
PriorityOrder
property includesLOCATION
. Locations are identified by AWS Region codes such asus-west-2
. Each location can only be listed once. - priority
Order List<"LATENCY" | "COST" | "DESTINATION" | "LOCATION"> - The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.
LATENCY
-- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.COST
-- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.DESTINATION
-- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.LOCATION
-- FleetIQ prioritizes based on the provided order of locations, as defined inLocationOrder
.
GameSessionQueuePriorityOrderItem
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.0.1 published on Tuesday, Oct 1, 2024 by Pulumi