com.amazonaws.services.kms.model

Class UpdateAliasRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.UpdateAliasRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class UpdateAliasRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the UpdateAlias operation.

Updates an alias to map it to a different key.

An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.

An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).

The alias and the key it is mapped to must be in the same AWS account and the same region.

See Also:

AWSKMS.updateAlias(UpdateAliasRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateAliasRequest()

Method Summary

Methods

Modifier and Type	Method and Description
UpdateAliasRequest	clone()
boolean	equals(Object obj)
String	getAliasName() String that contains the name of the alias to be modified.
String	getTargetKeyId() Unique identifier of the customer master key to be mapped to the alias.
int	hashCode()
void	setAliasName(String aliasName) String that contains the name of the alias to be modified.
void	setTargetKeyId(String targetKeyId) Unique identifier of the customer master key to be mapped to the alias.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateAliasRequest	withAliasName(String aliasName) String that contains the name of the alias to be modified.
UpdateAliasRequest	withTargetKeyId(String targetKeyId) Unique identifier of the customer master key to be mapped to the alias.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, 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

UpdateAliasRequest

public UpdateAliasRequest()

Method Detail

getAliasName

public String getAliasName()

String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

Returns:

String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

setAliasName

public void setAliasName(String aliasName)

String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

Parameters:

aliasName - String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

withAliasName

public UpdateAliasRequest withAliasName(String aliasName)

String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

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

Constraints:
Length: 1 - 256
Pattern: ^[a-zA-Z0-9:/_-]+$

Parameters:

aliasName - String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.

Returns:

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

getTargetKeyId

public String getTargetKeyId()

Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

Constraints:
Length: 1 - 256

Returns:

Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

setTargetKeyId

public void setTargetKeyId(String targetKeyId)

Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

Constraints:
Length: 1 - 256

Parameters:

targetKeyId - Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

withTargetKeyId

public UpdateAliasRequest withTargetKeyId(String targetKeyId)

Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

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

Constraints:
Length: 1 - 256

Parameters:

targetKeyId - Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.

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 UpdateAliasRequest clone()

Overrides:

clone in class AmazonWebServiceRequest