game_session_queues

Creates, updates, deletes or gets a game_session_queue resource or lists game_session_queues in a region

Overview

Name	game_session_queues
Type	Resource
Description	The AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.
Id	aws.gamelift.game_session_queues

Fields

Name	Datatype	Description
name	string	A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
timeout_in_seconds	integer	The maximum time, in seconds, that a new game session placement request remains in the queue.
destinations	array	A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
player_latency_policies	array	A set of policies that act as a sliding cap on player latency.
custom_event_data	string	Information that is added to all events that are related to this game session queue.
notification_target	string	An SNS topic ARN that is set up to receive game session placement notifications.
filter_configuration	object	A list of locations where a queue is allowed to place new game sessions.
priority_configuration	object	Custom settings to use when prioritizing destinations and locations for game session placements.
arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all game_session_queues in a region.

SELECT
region,
name,
timeout_in_seconds,
destinations,
player_latency_policies,
custom_event_data,
notification_target,
filter_configuration,
priority_configuration,
arn,
tags
FROM aws.gamelift.game_session_queues
WHERE region = 'us-east-1';

Gets all properties from an individual game_session_queue.

SELECT
region,
name,
timeout_in_seconds,
destinations,
player_latency_policies,
custom_event_data,
notification_target,
filter_configuration,
priority_configuration,
arn,
tags
FROM aws.gamelift.game_session_queues
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new game_session_queue resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.gamelift.game_session_queues (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.gamelift.game_session_queues (
 Name,
 TimeoutInSeconds,
 Destinations,
 PlayerLatencyPolicies,
 CustomEventData,
 NotificationTarget,
 FilterConfiguration,
 PriorityConfiguration,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ TimeoutInSeconds }}',
 '{{ Destinations }}',
 '{{ PlayerLatencyPolicies }}',
 '{{ CustomEventData }}',
 '{{ NotificationTarget }}',
 '{{ FilterConfiguration }}',
 '{{ PriorityConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: game_session_queue
    props:
      - name: Name
        value: '{{ Name }}'
      - name: TimeoutInSeconds
        value: '{{ TimeoutInSeconds }}'
      - name: Destinations
        value:
          - DestinationArn: '{{ DestinationArn }}'
      - name: PlayerLatencyPolicies
        value:
          - MaximumIndividualPlayerLatencyMilliseconds: '{{ MaximumIndividualPlayerLatencyMilliseconds }}'
            PolicyDurationSeconds: '{{ PolicyDurationSeconds }}'
      - name: CustomEventData
        value: '{{ CustomEventData }}'
      - name: NotificationTarget
        value: '{{ NotificationTarget }}'
      - name: FilterConfiguration
        value:
          AllowedLocations:
            - '{{ AllowedLocations[0] }}'
      - name: PriorityConfiguration
        value:
          LocationOrder:
            - '{{ LocationOrder[0] }}'
          PriorityOrder:
            - '{{ PriorityOrder[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.gamelift.game_session_queues
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the game_session_queues resource, the following permissions are required:

Create

gamelift:CreateGameSessionQueue,
gamelift:ListTagsForResource,
gamelift:TagResource

Read

gamelift:DescribeGameSessionQueues,
gamelift:ListTagsForResource

Delete

gamelift:DescribeGameSessionQueues,
gamelift:DeleteGameSessionQueue

Update

gamelift:UpdateGameSessionQueue,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:UntagResource

List

gamelift:DescribeGameSessionQueues