Class AliasProps
(experimental) Properties for a new Fleet alias.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.GameLift.Alpha
Assembly: Amazon.CDK.AWS.GameLift.Alpha.dll
Syntax (csharp)
public class AliasProps : Object, IAliasProps
Syntax (vb)
Public Class AliasProps
Inherits Object
Implements IAliasProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
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"
});
Synopsis
Constructors
AliasProps() |
Properties
AliasName | (experimental) Name of this alias. |
Description | (experimental) A human-readable description of the alias. |
Fleet | (experimental) A fleet that the alias points to. If specified, the alias resolves to one specific fleet. |
TerminalMessage | (experimental) The message text to be used with a terminal routing strategy. |
Constructors
AliasProps()
public AliasProps()
Properties
AliasName
(experimental) Name of this alias.
public string AliasName { get; set; }
Property Value
System.String
Remarks
Stability: Experimental
Description
(experimental) A human-readable description of the alias.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: no description
Stability: Experimental
Fleet
(experimental) A fleet that the alias points to. If specified, the alias resolves to one specific fleet.
public IFleet Fleet { get; set; }
Property Value
Remarks
At least one of fleet
and terminalMessage
must be provided.
Default: no fleet that the alias points to.
Stability: Experimental
TerminalMessage
(experimental) The message text to be used with a terminal routing strategy.
public string TerminalMessage { get; set; }
Property Value
System.String
Remarks
At least one of fleet
and terminalMessage
must be provided.
Default: no terminal message
Stability: Experimental