Package software.amazon.awscdk.services.gamelift

Class CfnAlias

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.gamelift.CfnAlias
All Implemented Interfaces:
IInspectable, ITaggableV2, IAliasRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:11.575Z") @Stability(Stable) public class CfnAlias extends CfnResource implements IInspectable, IAliasRef, ITaggableV2
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.services.gamelift.*;
 CfnAlias cfnAlias = CfnAlias.Builder.create(this, "MyCfnAlias")
         .name("name")
         .routingStrategy(RoutingStrategyProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .fleetId("fleetId")
                 .message("message")
                 .build())
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAlias

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

    • CfnAlias

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

    • CfnAlias

      @Stability(Stable) public CfnAlias(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAliasProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromAliasArn

      @Stability(Stable) @NotNull public static IAliasRef fromAliasArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IAliasRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromAliasId

      @Stability(Stable) @NotNull public static IAliasRef fromAliasId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String aliasId)
      Creates a new IAliasRef from a aliasId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      aliasId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAliasRef

      @Stability(Stable) @NotNull public AliasReference getAliasRef()
      A reference to a Alias resource.
      Specified by:
      getAliasRef in interface IAliasRef

    • getAttrAliasArn

      @Stability(Stable) @NotNull public String getAttrAliasArn()
      The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift alias ARN, the resource ID matches the alias ID value.

    • getAttrAliasId

      @Stability(Stable) @NotNull public String getAttrAliasId()
      A unique identifier for the alias. For example, arn:aws:gamelift:us-west-1::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

      Alias IDs are unique within a Region.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getName

      @Stability(Stable) @NotNull public String getName()
      A descriptive label that is associated with an alias.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A descriptive label that is associated with an alias.

    • getRoutingStrategy

      @Stability(Stable) @NotNull public Object getRoutingStrategy()
      The routing configuration, including routing type and fleet target, for the alias.

    • setRoutingStrategy

      @Stability(Stable) public void setRoutingStrategy(@NotNull IResolvable value)
      The routing configuration, including routing type and fleet target, for the alias.

    • setRoutingStrategy

      @Stability(Stable) public void setRoutingStrategy(@NotNull CfnAlias.RoutingStrategyProperty value)
      The routing configuration, including routing type and fleet target, for the alias.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A human-readable description of the alias.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A human-readable description of the alias.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.