Package software.amazon.awssdk.services.kms.model

Class UpdateAliasRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.kms.model.UpdateAliasRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>

@Generated("software.amazon.awssdk:codegen")
public class UpdateAliasRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateAliasRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
String	aliasName()	String that contains the name of the alias to be modified.
static UpdateAliasRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
static Class<? extends UpdateAliasRequest.Builder>	serializableBuilderClass()
String	targetKeyId()	Unique identifier of the customer master key to be mapped to 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()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

aliasName

public 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:

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.

targetKeyId

public 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:

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.

toBuilder

public UpdateAliasRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>

Returns:

a builder for type T

builder

public static UpdateAliasRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateAliasRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object