interface AliasProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.GameLift.Alpha.AliasProps |
 Go | github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#AliasProps |
 Java | software.amazon.awscdk.services.gamelift.alpha.AliasProps |
 Python | aws_cdk.aws_gamelift_alpha.AliasProps |
 TypeScript (source) | @aws-cdk/aws-gamelift-alpha » AliasProps |
Properties for a new Fleet alias.
Example
declare const fleet: gamelift.BuildFleet;
// Add an alias to an existing fleet using a dedicated fleet method
const liveAlias = fleet.addAlias('live');
// You can also create a standalone alias
new gamelift.Alias(this, 'TerminalAlias', {
aliasName: 'terminal-alias',
terminalMessage: 'A terminal message',
});
Properties
| Name | Type | Description |
|---|---|---|
| alias | string | Name of this alias. |
| description? | string | A human-readable description of the alias. |
| fleet? | IFleet | A fleet that the alias points to. If specified, the alias resolves to one specific fleet. |
| terminal | string | The message text to be used with a terminal routing strategy. |
aliasName
Type:
string
Name of this alias.
description?
Type:
string
(optional, default: no description)
A human-readable description of the alias.
fleet?
Type:
IFleet
(optional, default: no fleet that the alias points to.)
A fleet that the alias points to. If specified, the alias resolves to one specific fleet.
At least one of fleet and terminalMessage must be provided.
terminalMessage?
Type:
string
(optional, default: no terminal message)
The message text to be used with a terminal routing strategy.
At least one of fleet and terminalMessage must be provided.