Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.
Amazon GameLift 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, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias
.
Alias-related operations include:
CreateAlias
ListAliases
DescribeAlias
UpdateAlias
DeleteAlias
ResolveAlias
Synopsis
- createAlias :: Text -> RoutingStrategy -> CreateAlias
- data CreateAlias
- caDescription :: Lens' CreateAlias (Maybe Text)
- caName :: Lens' CreateAlias Text
- caRoutingStrategy :: Lens' CreateAlias RoutingStrategy
- createAliasResponse :: Int -> CreateAliasResponse
- data CreateAliasResponse
- carsAlias :: Lens' CreateAliasResponse (Maybe Alias)
- carsResponseStatus :: Lens' CreateAliasResponse Int
Creating a Request
Creates a value of CreateAlias
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
caDescription
- Human-readable description of an alias.caName
- Descriptive label that is associated with an alias. Alias names do not need to be unique.caRoutingStrategy
- Object that specifies the fleet and routing type to use for the alias.
data CreateAlias Source #
Represents the input for a request action.
See: createAlias
smart constructor.
Instances
Request Lenses
caDescription :: Lens' CreateAlias (Maybe Text) Source #
Human-readable description of an alias.
caName :: Lens' CreateAlias Text Source #
Descriptive label that is associated with an alias. Alias names do not need to be unique.
caRoutingStrategy :: Lens' CreateAlias RoutingStrategy Source #
Object that specifies the fleet and routing type to use for the alias.
Destructuring the Response
Creates a value of CreateAliasResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
carsAlias
- Object that describes the newly created alias record.carsResponseStatus
- -- | The response status code.
data CreateAliasResponse Source #
Represents the returned data in response to a request action.
See: createAliasResponse
smart constructor.
Instances
Response Lenses
carsAlias :: Lens' CreateAliasResponse (Maybe Alias) Source #
Object that describes the newly created alias record.
carsResponseStatus :: Lens' CreateAliasResponse Int Source #
- - | The response status code.