Skip to content
v2.277.0

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.

Example ​

ts
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',
});
python
# 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"
)
java
BuildFleet fleet;


// Add an alias to an existing fleet using a dedicated fleet method
Alias liveAlias = fleet.addAlias("live");

// You can also create a standalone alias
// You can also create a standalone alias
Alias.Builder.create(this, "TerminalAlias")
        .aliasName("terminal-alias")
        .terminalMessage("A terminal message")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.GameLift.Alpha
BuildFleet fleet;


// Add an alias to an existing fleet using a dedicated fleet method
var liveAlias = fleet.AddAlias("live");

// You can also create a standalone alias
// You can also create a standalone alias
new Alias(this, "TerminalAlias", new AliasProps {
    AliasName = "terminal-alias",
    TerminalMessage = "A terminal message"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdkgameliftalpha/v2
var fleet BuildFleet


// Add an alias to an existing fleet using a dedicated fleet method
liveAlias := fleet.AddAlias(jsii.String("live"))

// You can also create a standalone alias
// You can also create a standalone alias
gamelift.NewAlias(this, jsii.String("TerminalAlias"), &AliasProps{
	AliasName: jsii.String("terminal-alias"),
	TerminalMessage: jsii.String("A terminal message"),
})

Properties ​

aliasNamestringalias_namestraliasNameStringAliasNamestringAliasName*stringrequired#
Name of this alias.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A human-readable description of the alias.

Default: no description

fleetoptionalIFleetfleetoptionalIFleetfleetoptionalIFleetFleetoptionalIFleetFleetoptionalIFleet#
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.

terminalMessageoptionalstringterminal_messageoptionalstrterminalMessageoptionalStringTerminalMessageoptionalstringTerminalMessageoptional*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.