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:

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

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

Properties

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.

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

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

On this page:

• Syntax
• Properties
• Return Value
• Example