AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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://.awsapps.com.

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

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateAlias and EndCreateAlias.

Namespace: Amazon.DirectoryService
Assembly: AWSSDK.DirectoryService.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<CreateAliasResponse> CreateAliasAsync(
         CreateAliasRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.DirectoryService.Model.CreateAliasRequest

Container for the necessary parameters to execute the CreateAlias service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateAlias service method, as returned by DirectoryService.

Exceptions

ExceptionCondition
ClientException A client exception has occurred.
EntityAlreadyExistsException The specified entity already exists.
EntityDoesNotExistException The specified entity could not be found.
InvalidParameterException One or more parameters are not valid.
ServiceException An exception has occurred in Directory Service.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also