Network.AWS.GameLift.CreateAlias

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

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 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

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.5.0-LWFsf2alHztGD91U7ab8u0" 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 that is associated with an alias. Alias names do not need to be unique.

caRoutingStrategy :: Lens' CreateAlias RoutingStrategy

Object that specifies 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 that describes 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.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "CreateAliasResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_carsAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Alias))) (S1 (MetaSel (Just Symbol "_carsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

carsAlias :: Lens' CreateAliasResponse (Maybe Alias)

Object that describes the newly created alias record.

carsResponseStatus :: Lens' CreateAliasResponse Int

• - | The response status code.