@aws-cdk_aws-gamelift-alpha.AliasProps

interface AliasProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.GameLift.Alpha.AliasProps
Gogithub.com/aws/aws-cdk-go/awscdkgameliftalpha/v2#AliasProps
Javasoftware.amazon.awscdk.services.gamelift.alpha.AliasProps
Pythonaws_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

NameTypeDescription
aliasName๐Ÿ”นstringName of this alias.
description?๐Ÿ”นstringA human-readable description of the alias.
fleet?๐Ÿ”นIFleetA fleet that the alias points to. If specified, the alias resolves to one specific fleet.
terminalMessage?๐Ÿ”นstringThe 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.