Skip to content

Creates an alias for a directory and assigns the alias to the directory

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.

Usage

directoryservice_create_alias(DirectoryId, Alias)

Arguments

  • DirectoryId

    [required] The identifier of the directory for which to create the alias.

  • Alias

    [required] 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.

Value

A list with the following syntax:

list(
  DirectoryId = "string",
  Alias = "string"
)

Request syntax

svc$create_alias(
  DirectoryId = "string",
  Alias = "string"
)