Network.AWS.DirectoryService.CreateAlias

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 .

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

Creating a Request

createAlias

Arguments

:: Text

caDirectoryId

-> Text

caAlias

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

• caDirectoryId - The identifier of the directory for which to create the alias.
• caAlias - The requested alias. The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

data CreateAlias

Contains the inputs for the CreateAlias operation.

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.DirectoryService.CreateAlias" "amazonka-ds-1.5.0-1HLYDvwiZrU5lmpUrrPDdj" False) (C1 (MetaCons "CreateAlias'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_caDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_caAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs CreateAlias

type Rs CreateAlias = CreateAliasResponse

Request Lenses

caDirectoryId :: Lens' CreateAlias Text

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

caAlias :: Lens' CreateAlias Text

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

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:

• carsDirectoryId - The identifier of the directory.
• carsAlias - The alias for the directory.
• carsResponseStatus - -- | The response status code.

data CreateAliasResponse

Contains the results of the CreateAlias operation.

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.DirectoryService.CreateAlias" "amazonka-ds-1.5.0-1HLYDvwiZrU5lmpUrrPDdj" False) (C1 (MetaCons "CreateAliasResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_carsDirectoryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_carsAlias") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_carsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

carsDirectoryId :: Lens' CreateAliasResponse (Maybe Text)

The identifier of the directory.

carsAlias :: Lens' CreateAliasResponse (Maybe Text)

The alias for the directory.

carsResponseStatus :: Lens' CreateAliasResponse Int

• - | The response status code.