| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DirectoryService.CreateAlias
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
- data CreateAlias = CreateAlias' {
- directoryId :: Text
- alias :: Text
- newCreateAlias :: Text -> Text -> CreateAlias
- createAlias_directoryId :: Lens' CreateAlias Text
- createAlias_alias :: Lens' CreateAlias Text
- data CreateAliasResponse = CreateAliasResponse' {
- directoryId :: Maybe Text
- alias :: Maybe Text
- httpStatus :: Int
- newCreateAliasResponse :: Int -> CreateAliasResponse
- createAliasResponse_directoryId :: Lens' CreateAliasResponse (Maybe Text)
- createAliasResponse_alias :: Lens' CreateAliasResponse (Maybe Text)
- createAliasResponse_httpStatus :: Lens' CreateAliasResponse Int
Creating a Request
data CreateAlias Source #
Contains the inputs for the CreateAlias operation.
See: newCreateAlias smart constructor.
Constructors
| CreateAlias' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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:
$sel:directoryId:CreateAlias', createAlias_directoryId - The identifier of the directory for which to create the alias.
$sel:alias:CreateAlias', createAlias_alias - The requested alias.
The alias must be unique amongst all aliases in Amazon Web Services.
This operation throws an EntityAlreadyExistsException error if the
alias already exists.
Request Lenses
createAlias_directoryId :: Lens' CreateAlias Text Source #
The identifier of the directory for which to create the alias.
createAlias_alias :: Lens' CreateAlias Text Source #
The requested alias.
The alias must be unique amongst all aliases in Amazon Web Services.
This operation throws an EntityAlreadyExistsException error if the
alias already exists.
Destructuring the Response
data CreateAliasResponse Source #
Contains the results of the CreateAlias operation.
See: newCreateAliasResponse smart constructor.
Constructors
| CreateAliasResponse' | |
Fields
| |
Instances
newCreateAliasResponse Source #
Arguments
| :: Int | |
| -> 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:directoryId:CreateAlias', createAliasResponse_directoryId - The identifier of the directory.
$sel:alias:CreateAlias', createAliasResponse_alias - The alias for the directory.
$sel:httpStatus:CreateAliasResponse', createAliasResponse_httpStatus - The response's http status code.
Response Lenses
createAliasResponse_directoryId :: Lens' CreateAliasResponse (Maybe Text) Source #
The identifier of the directory.
createAliasResponse_alias :: Lens' CreateAliasResponse (Maybe Text) Source #
The alias for the directory.
createAliasResponse_httpStatus :: Lens' CreateAliasResponse Int Source #
The response's http status code.