AliasProps

class aws_cdk.aws_gamelift_alpha.AliasProps(*, alias_name, description=None, fleet=None, terminal_message=None)

Bases: object

(experimental) Properties for a new Fleet alias.

Parameters:

alias_name (str) – (experimental) Name of this alias.
description (Optional[str]) – (experimental) A human-readable description of the alias. Default: no description
fleet (Optional[IFleet]) – (experimental) 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. Default: no fleet that the alias points to.
terminal_message (Optional[str]) – (experimental) The message text to be used with a terminal routing strategy. At least one of fleet and terminalMessage must be provided. Default: no terminal message

Stability:

experimental

ExampleMetadata:

infused

Example:

# fleet: gamelift.BuildFleet


# Add an alias to an existing fleet using a dedicated fleet method
live_alias = fleet.add_alias("live")

# You can also create a standalone alias
gamelift.Alias(self, "TerminalAlias",
    alias_name="terminal-alias",
    terminal_message="A terminal message"
)

Attributes

alias_name

(experimental) Name of this alias.

Stability:: experimental

description

(experimental) A human-readable description of the alias.

Default:: no description
Stability:: experimental

fleet

(experimental) 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.

Default:: no fleet that the alias points to.
Stability:: experimental

terminal_message

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

At least one of fleet and terminalMessage must be provided.

Default:: no terminal message
Stability:: experimental