Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. gamelift
  5. getGameSessionQueue

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.gamelift.getGameSessionQueue

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 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>
    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.
    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 are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    PriorityOrder List<Pulumi.AwsNative.GameLift.GameSessionQueuePriorityOrderItem>
    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 in LocationOrder .
    LocationOrder []string
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    PriorityOrder []GameSessionQueuePriorityOrderItem
    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 in LocationOrder .
    locationOrder List<String>
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priorityOrder List<GameSessionQueuePriorityOrderItem>
    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 in LocationOrder .
    locationOrder string[]
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priorityOrder GameSessionQueuePriorityOrderItem[]
    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 in LocationOrder .
    location_order Sequence[str]
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priority_order Sequence[GameSessionQueuePriorityOrderItem]
    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 in LocationOrder .
    locationOrder List<String>
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priorityOrder 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 in LocationOrder .

    GameSessionQueuePriorityOrderItem

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native