@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 CMK.
|
static UpdateAliasRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateAliasRequest.Builder> |
serializableBuilderClass() |
String |
targetKeyId()
Identifies the customer managed CMK
to associate with the alias.
|
UpdateAliasRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String aliasName()
Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the
alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.
alias/ followed by
the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias
name.public final String targetKeyId()
Identifies the customer managed CMK to associate with the alias. You don't have permission to associate an alias with an AWS managed CMK.
The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct CMK, use ListAliases.
The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.
Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
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 CMK, use ListKeys or DescribeKey.
To verify that the alias is mapped to the correct CMK, use ListAliases.
public UpdateAliasRequest.Builder toBuilder()
ToCopyableBuildertoBuilder 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)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.