aliases

Creates, updates, deletes or gets an alias resource or lists aliases in a region

Overview

Name	aliases
Type	Resource
Description	The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.
Id	awscc.gamelift.aliases

Fields

Name	Datatype	Description
description	string	A human-readable description of the alias.
name	string	A descriptive label that is associated with an alias. Alias names do not need to be unique.
▶routing_strategy	object	A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.
alias_id	string	Unique alias ID
alias_arn	string	The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Alias resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift Alias ARN, the resource ID matches the AliasId value.
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, RoutingStrategy, 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 properties from an individual alias.

SELECT
region,
description,
name,
routing_strategy,
alias_id,
alias_arn,
tags
FROM awscc.gamelift.aliases
WHERE region = 'us-east-1' AND data__Identifier = '<AliasId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.gamelift.aliases (
 Name,
 RoutingStrategy,
 region
)
SELECT 
'{{ Name }}',
 '{{ RoutingStrategy }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.gamelift.aliases (
 Description,
 Name,
 RoutingStrategy,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ RoutingStrategy }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: alias
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: RoutingStrategy
        value:
          Message: '{{ Message }}'
          FleetId: '{{ FleetId }}'
          Type: '{{ Type }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.gamelift.aliases
WHERE data__Identifier = '<AliasId>'
AND region = 'us-east-1';

Permissions

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

Create

gamelift:CreateAlias,
gamelift:TagResource

Read

gamelift:DescribeAlias,
gamelift:ListTagsForResource

Update

gamelift:UpdateAlias,
gamelift:DescribeAlias,
gamelift:ListTagsForResource,
gamelift:TagResource,
gamelift:UntagResource

Delete

gamelift:DeleteAlias

List

gamelift:ListAliases