Amazonka.GameLift.CreateAlias

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

Creating a Request

data CreateAlias

See: newCreateAlias smart constructor.

Constructors

CreateAlias'

Fields

• description :: Maybe Text

  A human-readable description of the alias.

• tags :: Maybe [Tag]

  A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

• name :: Text

  A descriptive label that is associated with an alias. Alias names do not need to be unique.

• routingStrategy :: RoutingStrategy

  The routing configuration, including routing type and fleet target, for the alias.

Instances

ToJSON CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

toJSON :: CreateAlias -> Value

toEncoding :: CreateAlias -> Encoding

toJSONList :: [CreateAlias] -> Value

toEncodingList :: [CreateAlias] -> Encoding

ToHeaders CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

toHeaders :: CreateAlias -> [Header]

ToPath CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

toPath :: CreateAlias -> ByteString

ToQuery CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

toQuery :: CreateAlias -> QueryString

AWSRequest CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Associated Types

type AWSResponse CreateAlias

Methods

request :: (Service -> Service) -> CreateAlias -> Request CreateAlias

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAlias)))

Generic CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Associated Types

type Rep CreateAlias :: Type -> Type

Methods

from :: CreateAlias -> Rep CreateAlias x

to :: Rep CreateAlias x -> CreateAlias

Read CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

readsPrec :: Int -> ReadS CreateAlias

readList :: ReadS [CreateAlias]

readPrec :: ReadPrec CreateAlias

readListPrec :: ReadPrec [CreateAlias]

Show CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

showsPrec :: Int -> CreateAlias -> ShowS

show :: CreateAlias -> String

showList :: [CreateAlias] -> ShowS

NFData CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

rnf :: CreateAlias -> ()

Eq CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

(==) :: CreateAlias -> CreateAlias -> Bool

(/=) :: CreateAlias -> CreateAlias -> Bool

Hashable CreateAlias

Defined in Amazonka.GameLift.CreateAlias

Methods

hashWithSalt :: Int -> CreateAlias -> Int

hash :: CreateAlias -> Int

type AWSResponse CreateAlias

Defined in Amazonka.GameLift.CreateAlias

type AWSResponse CreateAlias = CreateAliasResponse

type Rep CreateAlias

Defined in Amazonka.GameLift.CreateAlias

type Rep CreateAlias = D1 ('MetaData "CreateAlias" "Amazonka.GameLift.CreateAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "CreateAlias'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "routingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RoutingStrategy))))

newCreateAlias

Arguments

:: Text

CreateAlias

-> RoutingStrategy

CreateAlias

-> CreateAlias

Create a value of CreateAlias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAlias, createAlias_description - A human-readable description of the alias.

$sel:tags:CreateAlias', createAlias_tags - A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

CreateAlias, createAlias_name - A descriptive label that is associated with an alias. Alias names do not need to be unique.

CreateAlias, createAlias_routingStrategy - The routing configuration, including routing type and fleet target, for the alias.

Request Lenses

createAlias_description :: Lens' CreateAlias (Maybe Text)

A human-readable description of the alias.

createAlias_tags :: Lens' CreateAlias (Maybe [Tag])

A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

createAlias_name :: Lens' CreateAlias Text

A descriptive label that is associated with an alias. Alias names do not need to be unique.

createAlias_routingStrategy :: Lens' CreateAlias RoutingStrategy

The routing configuration, including routing type and fleet target, for the alias.

Destructuring the Response

data CreateAliasResponse

See: newCreateAliasResponse smart constructor.

Constructors

CreateAliasResponse'

Fields

• alias :: Maybe Alias

  The newly created alias resource.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateAliasResponse

Defined in Amazonka.GameLift.CreateAlias

Associated Types

type Rep CreateAliasResponse :: Type -> Type

Methods

from :: CreateAliasResponse -> Rep CreateAliasResponse x

to :: Rep CreateAliasResponse x -> CreateAliasResponse

Read CreateAliasResponse

Defined in Amazonka.GameLift.CreateAlias

Methods

readsPrec :: Int -> ReadS CreateAliasResponse

readList :: ReadS [CreateAliasResponse]

readPrec :: ReadPrec CreateAliasResponse

readListPrec :: ReadPrec [CreateAliasResponse]

Show CreateAliasResponse

Defined in Amazonka.GameLift.CreateAlias

Methods

showsPrec :: Int -> CreateAliasResponse -> ShowS

show :: CreateAliasResponse -> String

showList :: [CreateAliasResponse] -> ShowS

NFData CreateAliasResponse

Defined in Amazonka.GameLift.CreateAlias

Methods

rnf :: CreateAliasResponse -> ()

Eq CreateAliasResponse

Defined in Amazonka.GameLift.CreateAlias

Methods

(==) :: CreateAliasResponse -> CreateAliasResponse -> Bool

(/=) :: CreateAliasResponse -> CreateAliasResponse -> Bool

type Rep CreateAliasResponse

Defined in Amazonka.GameLift.CreateAlias

type Rep CreateAliasResponse = D1 ('MetaData "CreateAliasResponse" "Amazonka.GameLift.CreateAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "CreateAliasResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Alias)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateAliasResponse

Arguments

:: Int

$sel:httpStatus:CreateAliasResponse'

-> CreateAliasResponse

Create a value of CreateAliasResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alias:CreateAliasResponse', createAliasResponse_alias - The newly created alias resource.

$sel:httpStatus:CreateAliasResponse', createAliasResponse_httpStatus - The response's http status code.

Response Lenses

createAliasResponse_alias :: Lens' CreateAliasResponse (Maybe Alias)

The newly created alias resource.

createAliasResponse_httpStatus :: Lens' CreateAliasResponse Int

The response's http status code.