| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.GameLift.CreateAlias
Description
Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.
To create a fleet alias, specify an alias name, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
- 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
Arguments
| :: Text | |
| -> RoutingStrategy | |
| -> CreateAlias |
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:
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 the alias.
caName :: Lens' CreateAlias Text Source
Descriptive label associated with this alias. Alias names do not need to be unique.
caRoutingStrategy :: Lens' CreateAlias RoutingStrategy Source
Object specifying the fleet and routing type to use for the alias.
Destructuring the Response
Arguments
| :: Int | |
| -> CreateAliasResponse |
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:
data CreateAliasResponse Source
Represents the returned data in response to a request action.
See: createAliasResponse smart constructor.
Response Lenses
carsAlias :: Lens' CreateAliasResponse (Maybe Alias) Source
Object containing the newly created alias record.
carsResponseStatus :: Lens' CreateAliasResponse Int Source
The response status code.