public class UpdateAliasRequest extends AmazonWebServiceRequest implements java.io.Serializable
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.
Constructor and Description |
---|
UpdateAliasRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAliasName()
String that contains the name of the alias to be modified.
|
java.lang.String |
getTargetKeyId()
Unique identifier of the customer master key to be mapped to the alias.
|
int |
hashCode() |
void |
setAliasName(java.lang.String aliasName)
String that contains the name of the alias to be modified.
|
void |
setTargetKeyId(java.lang.String targetKeyId)
Unique identifier of the customer master key to be mapped to the alias.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
UpdateAliasRequest |
withAliasName(java.lang.String aliasName)
String that contains the name of the alias to be modified.
|
UpdateAliasRequest |
withTargetKeyId(java.lang.String targetKeyId)
Unique identifier of the customer master key to be mapped to the alias.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.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:/_-]+$
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.
public void setAliasName(java.lang.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:/_-]+$
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.
public UpdateAliasRequest withAliasName(java.lang.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:/_-]+$
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.
public java.lang.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
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
.
public void setTargetKeyId(java.lang.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
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
.
public UpdateAliasRequest withTargetKeyId(java.lang.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
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
.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.