Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS::GameLift::Alias

The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet, which you can use to anonymize your fleet. You can reference the alias instead of a specific fleet when you create game sessions. For more information, see the CreateAlias action in the Amazon GameLift API Reference.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

Copy
{ "Type" : "AWS::GameLift::Alias", "Properties" : { "Name" : String, "Description" : String, "RoutingStrategy" : RoutingStrategy } }

YAML

Copy
Type: "AWS::GameLift::Alias" Properties: Name: String Description: String RoutingStrategy: RoutingStrategy

Properties

Description

Information that helps you identify the purpose of this alias.

Required: No

Type: String

Update requires: No interruption

Name

An identifier to associate with this alias. Alias names don't need to be unique.

Required: Yes

Type: String

Update requires: No interruption

RoutingStrategy

A routing configuration that specifies where traffic is directed for this alias, such as to a fleet or to a message.

Required: Yes

Type: Amazon GameLift Alias RoutingStrategy

Update requires: No interruption

Return Value

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the alias ID, such as myalias-a01234b56-7890-1de2-f345-g67h8i901j2k.

For more information about using the Ref function, see Ref.

Example

The following example creates a terminal alias named TerminalAlias with a generic terminal message.

JSON

Copy
"AliasResource": { "Type": "AWS::GameLift::Alias", "Properties": { "Name": "TerminalAlias", "Description": "A terminal alias", "RoutingStrategy": { "Type": "TERMINAL", "Message": "Terminal routing strategy message" } } }

YAML

Copy
AliasResource: Type: "AWS::GameLift::Alias" Properties: Name: "TerminalAlias" Description: "A terminal alias" RoutingStrategy: Type: "TERMINAL" Message: "Terminal routing strategy message"