AWS::GameLift::Alias RoutingStrategy - AWS CloudFormation
SyntaxPropertiesSee also

AWS::GameLift::Alias RoutingStrategy

The routing configuration for a fleet alias.

Syntax

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

JSON

{
  "FleetId" : String,
  "Message" : String,
  "Type" : String
}

YAML

  FleetId: String
  Message: String
  Type: String

Properties

FleetId

A unique identifier for a fleet that the alias points to. If you specify SIMPLE for the Type property, you must specify this property.

Required: Conditional

Type: String

Pattern: ^[a-z]*fleet-[a-zA-Z0-9\-]+

Update requires: No interruption

Message

The message text to be used with a terminal routing strategy. If you specify TERMINAL for the Type property, you must specify this property.

Required: Conditional

Type: String

Update requires: No interruption

Type

A type of routing strategy.

Possible routing types include the following:

  • SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message that you specified in the Message property.

Required: Yes

Type: String

Allowed values: SIMPLE | TERMINAL

Update requires: No interruption

See also