@Generated(value="software.amazon.awssdk:codegen") public final class UpdateAliasRequest extends KmsRequest implements ToCopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateAliasRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
aliasName()
Identifies the alias that is changing its KMS key.
|
static UpdateAliasRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateAliasRequest.Builder> |
serializableBuilderClass() |
String |
targetKeyId()
Identifies the customer managed key
to associate with the alias.
|
UpdateAliasRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String aliasName()
Identifies the alias that is changing its KMS key. This value must begin with alias/ followed by the
alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias
name.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
alias/
followed by the alias name, such as alias/ExampleAlias. You cannot use
UpdateAlias to change the alias name. Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
public final String targetKeyId()
Identifies the customer managed key to associate with the alias. You don't have permission to associate an alias with an Amazon Web Services managed key.
The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct KMS key, use ListAliases.
The KMS key must be in the same Amazon Web Services account and Region as the alias. Also, the new target KMS key must be the same type as the current target KMS key (both symmetric or both asymmetric or both HMAC) and they must have the same key usage.
Specify the key ID or key ARN of the KMS key.
For example:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct KMS key, use ListAliases.
public UpdateAliasRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>toBuilder in class KmsRequestpublic static UpdateAliasRequest.Builder builder()
public static Class<? extends UpdateAliasRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.