locations

Creates, updates, deletes or gets a location resource or lists locations in a region

Overview

Name	locations
Type	Resource
Description	The AWS::GameLift::Location resource creates an Amazon GameLift (GameLift) custom location.
Id	aws.gamelift.locations

Fields

Name	Datatype	Description
location_name	string
location_arn	string
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	LocationName, 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 locations in a region.

SELECT
region,
location_name,
location_arn,
tags
FROM aws.gamelift.locations
WHERE region = 'us-east-1';

Gets all properties from an individual location.

SELECT
region,
location_name,
location_arn,
tags
FROM aws.gamelift.locations
WHERE region = 'us-east-1' AND data__Identifier = '<LocationName>';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO aws.gamelift.locations (
 LocationName,
 Tags,
 region
)
SELECT 
 '{{ LocationName }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: location
    props:
      - name: LocationName
        value: '{{ LocationName }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

gamelift:CreateLocation,
gamelift:ListLocations,
gamelift:ListTagsForResource,
gamelift:TagResource

Read

gamelift:ListLocations,
gamelift:ListTagsForResource

Delete

gamelift:DeleteLocation

List

gamelift:ListLocations

Update

gamelift:ListLocations,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:UntagResource