AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::GameLift::Alias

CfnAlias

The `AWS::GameLift::Alias` resource creates an alias for an Amazon GameLift (GameLift) fleet destination. There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

Import

import { CfnAlias } from 'aws-cdk-lib/aws-gamelift';

Or use the module namespace:

import * as gamelift from 'aws-cdk-lib/aws-gamelift';
// gamelift.CfnAlias

Properties

Configuration passed to the constructor as CfnAliasProps.

nameRequired
string

A descriptive label that is associated with an alias. Alias names do not need to be unique.

routingStrategyRequired
IResolvable | RoutingStrategyProperty

The routing configuration, including routing type and fleet target, for the alias.

descriptionOptional
string

A human-readable description of the alias.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::GameLift::AliasView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-gamelift
CFN TypeAWS::GameLift::Alias
Properties4

Related Constructs

Explore This Service

External Links