Package software.amazon.awscdk.services.gamelift.alpha

Interface AliasProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AliasProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:26.598Z") @Stability(Experimental) public interface AliasProps extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for a new Fleet alias.

Example: 

 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();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    AliasProps.Builder
    A builder for AliasProps
    static final class 
    AliasProps.Jsii$Proxy
    An implementation for AliasProps

  • Method Summary

    Modifier and Type
    Method
    Description
    static AliasProps.Builder
    builder()
     
    String
    getAliasName()
    (experimental) Name of this alias.
    default String
    getDescription()
    (experimental) A human-readable description of the alias.
    default IFleet
    getFleet()
    (experimental) A fleet that the alias points to.
    default String
    getTerminalMessage()
    (experimental) The message text to be used with a terminal routing strategy.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getAliasName

      @Stability(Experimental) @NotNull String getAliasName()
      (experimental) Name of this alias.

    • getDescription

      @Stability(Experimental) @Nullable default String getDescription()
      (experimental) A human-readable description of the alias.

      Default: no description

    • getFleet

      @Stability(Experimental) @Nullable default IFleet getFleet()
      (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.

    • getTerminalMessage

      @Stability(Experimental) @Nullable default String getTerminalMessage()
      (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

    • builder

      @Stability(Experimental) static AliasProps.Builder builder()
      Returns:
      a AliasProps.Builder of AliasProps