amazonka-ds-1.4.0: Amazon Directory Service SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.DirectoryService.CreateAlias

Contents

Description

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as 'http://<alias>.awsapps.com'.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

Synopsis

Creating a Request

createAlias Source

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:

Request Lenses

caDirectoryId :: Lens' CreateAlias Text Source

The identifier of the directory for which to create the alias.

caAlias :: Lens' CreateAlias Text Source

The requested alias.

The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

Destructuring the Response

createAliasResponse Source

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:

Response Lenses

carsDirectoryId :: Lens' CreateAliasResponse (Maybe Text) Source

The identifier of the directory.

carsAlias :: Lens' CreateAliasResponse (Maybe Text) Source

The alias for the directory.