Package software.amazon.awscdk.cfnpropertymixins.services.gamelift

Class CfnAliasPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.gamelift.CfnAliasPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:59.567Z") @Stability(Stable) public class CfnAliasPropsMixin extends Mixin implements software.constructs.IMixin
The AWS::GameLift::Alias resource creates an alias for an Amazon GameLift (GameLift) fleet destination.

There are two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias displays a message instead of routing players to an active fleet. For example, a terminal alias might display a URL link that directs players to an upgrade site. You can use aliases to define destinations in a game session queue or when requesting new game sessions.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.gamelift.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnAliasPropsMixin cfnAliasPropsMixin = CfnAliasPropsMixin.Builder.create(CfnAliasMixinProps.builder()
         .description("description")
         .name("name")
         .routingStrategy(RoutingStrategyProperty.builder()
                 .fleetId("fleetId")
                 .message("message")
                 .type("type")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnAliasPropsMixin.Builder
    A fluent builder for CfnAliasPropsMixin.
    static interface 
    CfnAliasPropsMixin.RoutingStrategyProperty
    The routing configuration for a fleet alias.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnAliasPropsMixin(CfnAliasMixinProps props)
    Create a mixin to apply properties to AWS::GameLift::Alias.
     
    CfnAliasPropsMixin(CfnAliasMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::GameLift::Alias.
    protected
    CfnAliasPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnAliasPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnAliasMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnAliasPropsMixin

      protected CfnAliasPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAliasPropsMixin

      protected CfnAliasPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAliasPropsMixin

      @Stability(Stable) public CfnAliasPropsMixin(@NotNull CfnAliasMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::GameLift::Alias.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnAliasPropsMixin

      @Stability(Stable) public CfnAliasPropsMixin(@NotNull CfnAliasMixinProps props)
      Create a mixin to apply properties to AWS::GameLift::Alias.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnAliasMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()