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	awscc.gamelift.game_session_queues

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
name	string	A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
region	string	AWS region.

For more information, see AWS::GameLift::GameSessionQueue.

Methods

Name	Resource	Accessible by	Required Params
create_resource	game_session_queues	INSERT	Name, region
delete_resource	game_session_queues	DELETE	Identifier, region
update_resource	game_session_queues	UPDATE	Identifier, PatchDocument, region
list_resources	game_session_queues_list_only	SELECT	region
get_resource	game_session_queues	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.gamelift.game_session_queues
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all game_session_queues in a region.

SELECT
  region,
  name
FROM awscc.gamelift.game_session_queues_list_only
WHERE
  region = '{{ region }}';

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 awscc.gamelift.game_session_queues (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.gamelift.game_session_queues (
  Name,
  TimeoutInSeconds,
  Destinations,
  PlayerLatencyPolicies,
  CustomEventData,
  NotificationTarget,
  FilterConfiguration,
  PriorityConfiguration,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ timeout_in_seconds }}',
  '{{ destinations }}',
  '{{ player_latency_policies }}',
  '{{ custom_event_data }}',
  '{{ notification_target }}',
  '{{ filter_configuration }}',
  '{{ priority_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: timeout_in_seconds
      value: '{{ timeout_in_seconds }}'
    - name: destinations
      value:
        - destination_arn: '{{ destination_arn }}'
    - name: player_latency_policies
      value:
        - maximum_individual_player_latency_milliseconds: '{{ maximum_individual_player_latency_milliseconds }}'
          policy_duration_seconds: '{{ policy_duration_seconds }}'
    - name: custom_event_data
      value: '{{ custom_event_data }}'
    - name: notification_target
      value: '{{ notification_target }}'
    - name: filter_configuration
      value:
        allowed_locations:
          - '{{ allowed_locations[0] }}'
    - name: priority_configuration
      value:
        location_order:
          - '{{ location_order[0] }}'
        priority_order:
          - '{{ priority_order[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.gamelift.game_session_queues
SET PatchDocument = string('{{ {
    "TimeoutInSeconds": timeout_in_seconds,
    "Destinations": destinations,
    "PlayerLatencyPolicies": player_latency_policies,
    "CustomEventData": custom_event_data,
    "NotificationTarget": notification_target,
    "FilterConfiguration": filter_configuration,
    "PriorityConfiguration": priority_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.gamelift.game_session_queues
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

gamelift:CreateGameSessionQueue,
gamelift:DescribeGameSessionQueues,
gamelift:ListTagsForResource,
gamelift:TagResource

Read

gamelift:DescribeGameSessionQueues,
gamelift:ListTagsForResource

Delete

gamelift:DescribeGameSessionQueues,
gamelift:DeleteGameSessionQueue

Update

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

List

gamelift:DescribeGameSessionQueues