Module Smaws_Client_GameLift.CreateAlias

This API works with the following fleet types: EC2, Anywhere, Container

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.

Amazon GameLift Servers supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.

Related actions

All APIs by task

val error_to_string : [ Smaws_Lib.Protocols.AwsJson.error | `ConflictException of Types.conflict_exception | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `LimitExceededException of Types.limit_exceeded_exception | `TaggingFailedException of Types.tagging_failed_exception | `UnauthorizedException of Types.unauthorized_exception ] -> string
val request : 'http_type Smaws_Lib.Context.t -> Types.create_alias_input -> (Types.create_alias_output, [> Smaws_Lib.Protocols.AwsJson.error | `ConflictException of Types.conflict_exception | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `LimitExceededException of Types.limit_exceeded_exception | `TaggingFailedException of Types.tagging_failed_exception | `UnauthorizedException of Types.unauthorized_exception ]) Stdlib.result
val request_with_metadata : 'http_type Smaws_Lib.Context.t -> Types.create_alias_input -> (Types.create_alias_output Smaws_Lib.Response.t, [> Smaws_Lib.Protocols.AwsJson.error | `ConflictException of Types.conflict_exception | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `LimitExceededException of Types.limit_exceeded_exception | `TaggingFailedException of Types.tagging_failed_exception | `UnauthorizedException of Types.unauthorized_exception ] * Smaws_Lib.Response.metadata) Stdlib.result