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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
alias_id	string	Unique alias ID
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	aliases	INSERT	Name, RoutingStrategy, region
delete_resource	aliases	DELETE	Identifier, region
update_resource	aliases	UPDATE	Identifier, PatchDocument, region
list_resources	aliases_list_only	SELECT	region
get_resource	aliases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual alias.

SELECT
  region,
  description,
  name,
  routing_strategy,
  alias_id,
  alias_arn,
  tags
FROM awscc.gamelift.aliases
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ alias_id }}';

list (identifiers only)

Lists all aliases in a region.

SELECT
  region,
  alias_id
FROM awscc.gamelift.aliases_list_only
WHERE
  region = '{{ region }}';

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 }}',
  '{{ routing_strategy }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.gamelift.aliases (
  Description,
  Name,
  RoutingStrategy,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ routing_strategy }}',
  '{{ 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: alias
  props:
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: routing_strategy
      value:
        message: '{{ message }}'
        fleet_id: '{{ fleet_id }}'
        type: '{{ type }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.gamelift.aliases
SET PatchDocument = string('{{ {
    "Description": description,
    "Name": name,
    "RoutingStrategy": routing_strategy,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ alias_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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