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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
location_name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	locations	INSERT	LocationName, region
delete_resource	locations	DELETE	Identifier, region
update_resource	locations	UPDATE	Identifier, PatchDocument, region
list_resources	locations_list_only	SELECT	region
get_resource	locations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual location.

SELECT
  region,
  location_name,
  location_arn,
  tags
FROM awscc.gamelift.locations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ location_name }}';

list (identifiers only)

Lists all locations in a region.

SELECT
  region,
  location_name
FROM awscc.gamelift.locations_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.gamelift.locations (
  LocationName,
  Tags,
  region
)
SELECT
  '{{ location_name }}',
  '{{ 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: location_name
        value: '{{ location_name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.gamelift.locations
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ location_name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.gamelift.locations
WHERE
  Identifier = '{{ location_name }}' 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