com.amazonaws.services.directory.model

Class CreateAliasRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.directory.model.CreateAliasRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateAliasRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateAlias operation.

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 .

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

See Also:

AWSDirectoryService.createAlias(CreateAliasRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAliasRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateAliasRequest	clone()
boolean	equals(Object obj)
String	getAlias() The requested alias.
String	getDirectoryId() The identifier of the directory to create the alias for.
int	hashCode()
void	setAlias(String alias) The requested alias.
void	setDirectoryId(String directoryId) The identifier of the directory to create the alias for.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateAliasRequest	withAlias(String alias) The requested alias.
CreateAliasRequest	withDirectoryId(String directoryId) The identifier of the directory to create the alias for.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAliasRequest

public CreateAliasRequest()

Method Detail

getDirectoryId

public String getDirectoryId()

The identifier of the directory to create the alias for.

Constraints:
Pattern: ^d-[0-9a-f]{10}$

Returns:

The identifier of the directory to create the alias for.

setDirectoryId

public void setDirectoryId(String directoryId)

The identifier of the directory to create the alias for.

Constraints:
Pattern: ^d-[0-9a-f]{10}$

Parameters:

directoryId - The identifier of the directory to create the alias for.

withDirectoryId

public CreateAliasRequest withDirectoryId(String directoryId)

The identifier of the directory to create the alias for.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^d-[0-9a-f]{10}$

Parameters:

directoryId - The identifier of the directory to create the alias for.

Returns:

A reference to this updated object so that method calls can be chained together.

getAlias

public String getAlias()

The requested alias.

The alias must be unique amongst all aliases in AWS. This operation will throw an EntityAlreadyExistsException if this alias already exists.

Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

Returns:

The requested alias.

The alias must be unique amongst all aliases in AWS. This operation will throw an EntityAlreadyExistsException if this alias already exists.

setAlias

public void setAlias(String alias)

The requested alias.

The alias must be unique amongst all aliases in AWS. This operation will throw an EntityAlreadyExistsException if this alias already exists.

Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

Parameters:

alias - The requested alias.

The alias must be unique amongst all aliases in AWS. This operation will throw an EntityAlreadyExistsException if this alias already exists.

withAlias

public CreateAliasRequest withAlias(String alias)

The requested alias.

The alias must be unique amongst all aliases in AWS. This operation will throw an EntityAlreadyExistsException if this alias already exists.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 62
Pattern: ^(?!d-)([\da-zA-Z]+)([-]*[\da-zA-Z])*

Parameters:

alias - The requested alias.

The alias must be unique amongst all aliases in AWS. This operation will throw an EntityAlreadyExistsException if this alias already exists.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateAliasRequest clone()

Overrides:

clone in class AmazonWebServiceRequest