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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 .

Synopsis

Creating a Request

createAlias #

Arguments

:: Text	`caName`
-> RoutingStrategy	`caRoutingStrategy`
-> 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:

caDescription - Human-readable description of an alias.
caName - Descriptive label associated with an alias. Alias names do not need to be unique.
caRoutingStrategy - Object specifying the fleet and routing type to use for the alias.

data CreateAlias #

Represents the input for a request action.

See: createAlias smart constructor.

Instances

Eq CreateAlias #
Methods (==) :: CreateAlias -> CreateAlias -> Bool # (/=) :: CreateAlias -> CreateAlias -> Bool #
Data CreateAlias #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateAlias -> c CreateAlias # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateAlias # toConstr :: CreateAlias -> Constr # dataTypeOf :: CreateAlias -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CreateAlias) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateAlias) # gmapT :: (forall b. Data b => b -> b) -> CreateAlias -> CreateAlias # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateAlias -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateAlias -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateAlias -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateAlias -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateAlias -> m CreateAlias # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAlias -> m CreateAlias # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAlias -> m CreateAlias #
Read CreateAlias #
Methods readsPrec :: Int -> ReadS CreateAlias # readList :: ReadS [CreateAlias] # readPrec :: ReadPrec CreateAlias # readListPrec :: ReadPrec [CreateAlias] #
Show CreateAlias #
Methods showsPrec :: Int -> CreateAlias -> ShowS # show :: CreateAlias -> String # showList :: [CreateAlias] -> ShowS #
Generic CreateAlias #
Associated Types type Rep CreateAlias :: * -> * # Methods from :: CreateAlias -> Rep CreateAlias x # to :: Rep CreateAlias x -> CreateAlias #
Hashable CreateAlias #
Methods hashWithSalt :: Int -> CreateAlias -> Int # hash :: CreateAlias -> Int #
ToJSON CreateAlias #
Methods toJSON :: CreateAlias -> Value # toEncoding :: CreateAlias -> Encoding # toJSONList :: [CreateAlias] -> Value # toEncodingList :: [CreateAlias] -> Encoding #
NFData CreateAlias #
Methods rnf :: CreateAlias -> () #
AWSRequest CreateAlias #
Associated Types type Rs CreateAlias :: * # Methods request :: CreateAlias -> Request CreateAlias # response :: MonadResource m => Logger -> Service -> Proxy * CreateAlias -> ClientResponse -> m (Response CreateAlias) #
ToQuery CreateAlias #
Methods toQuery :: CreateAlias -> QueryString #
ToPath CreateAlias #
Methods toPath :: CreateAlias -> ByteString #
ToHeaders CreateAlias #
Methods toHeaders :: CreateAlias -> [Header] #
type Rep CreateAlias #
type Rep CreateAlias = D1 (MetaData "CreateAlias" "Network.AWS.GameLift.CreateAlias" "amazonka-gamelift-1.4.5-90oxfPbG0dmH3SoKqzJqw8" False) (C1 (MetaCons "CreateAlias'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_caDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((::) (S1 (MetaSel (Just Symbol "_caName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_caRoutingStrategy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 RoutingStrategy)))))
type Rs CreateAlias #
type Rs CreateAlias = CreateAliasResponse

Request Lenses

caDescription :: Lens' CreateAlias (Maybe Text) #

Human-readable description of an alias.

caName :: Lens' CreateAlias Text #

Descriptive label associated with an alias. Alias names do not need to be unique.

caRoutingStrategy :: Lens' CreateAlias RoutingStrategy #

Object specifying the fleet and routing type to use for the alias.

Destructuring the Response

createAliasResponse #

Arguments

:: Int	`carsResponseStatus`
-> 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:

carsAlias - Object containing the newly created alias record.
carsResponseStatus - -- | The response status code.

data CreateAliasResponse #

Represents the returned data in response to a request action.

See: createAliasResponse smart constructor.

Instances

Eq CreateAliasResponse #
Methods (==) :: CreateAliasResponse -> CreateAliasResponse -> Bool # (/=) :: CreateAliasResponse -> CreateAliasResponse -> Bool #
Data CreateAliasResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateAliasResponse -> c CreateAliasResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateAliasResponse # toConstr :: CreateAliasResponse -> Constr # dataTypeOf :: CreateAliasResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c CreateAliasResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateAliasResponse) # gmapT :: (forall b. Data b => b -> b) -> CreateAliasResponse -> CreateAliasResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateAliasResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateAliasResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> CreateAliasResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateAliasResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateAliasResponse -> m CreateAliasResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAliasResponse -> m CreateAliasResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateAliasResponse -> m CreateAliasResponse #
Read CreateAliasResponse #
Methods readsPrec :: Int -> ReadS CreateAliasResponse # readList :: ReadS [CreateAliasResponse] # readPrec :: ReadPrec CreateAliasResponse # readListPrec :: ReadPrec [CreateAliasResponse] #
Show CreateAliasResponse #
Methods showsPrec :: Int -> CreateAliasResponse -> ShowS # show :: CreateAliasResponse -> String # showList :: [CreateAliasResponse] -> ShowS #
Generic CreateAliasResponse #
Associated Types type Rep CreateAliasResponse :: * -> * # Methods from :: CreateAliasResponse -> Rep CreateAliasResponse x # to :: Rep CreateAliasResponse x -> CreateAliasResponse #
NFData CreateAliasResponse #
Methods rnf :: CreateAliasResponse -> () #
type Rep CreateAliasResponse #
type Rep CreateAliasResponse = D1 (MetaData "CreateAliasResponse" "Network.AWS.GameLift.CreateAlias" "amazonka-gamelift-1.4.5-90oxfPbG0dmH3SoKqzJqw8" False) (C1 (MetaCons "CreateAliasResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_carsAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Alias))) (S1 (MetaSel (Just Symbol "_carsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

carsAlias :: Lens' CreateAliasResponse (Maybe Alias) #

Object containing the newly created alias record.

carsResponseStatus :: Lens' CreateAliasResponse Int #

- | The response status code.