@aws-cdk/aws-gamelift-alpha.AliasProps

Experimental

@aws-cdk/aws-gamelift-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

AliasProps Struct

Properties for a new Fleet alias.

AliasProps

used as props by

• Alias

Stability

Experimental

Source

lib/alias.ts

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

aliasNamestringalias_namestraliasNameStringAliasNamestringAliasName*stringrequired#

Name of this alias.

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A human-readable description of the alias.

Default: no description

fleet?optionalIFleetfleet?optionalIFleetfleet?optionalIFleetFleet?optionalIFleetFleet?optionalIFleet#

A fleet that the alias points to. If specified, the alias resolves to one specific fleet.

Default: no fleet that the alias points to.

At least one of fleet and terminalMessage must be provided.

terminalMessage?optionalstringterminal_message?optionalstrterminalMessage?optionalStringTerminalMessage?optionalstringTerminalMessage?optional*string#

The message text to be used with a terminal routing strategy.

Default: no terminal message

At least one of fleet and terminalMessage must be provided.