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

Class UpdateKeyDescriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.UpdateKeyDescriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateKeyDescriptionRequest.Builder,UpdateKeyDescriptionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateKeyDescriptionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateKeyDescriptionRequest.Builder	builder()
String	description()	New description for the KMS key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	Updates the description of the specified KMS key.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateKeyDescriptionRequest.Builder>	serializableBuilderClass()
UpdateKeyDescriptionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

keyId

public final String keyId()

Updates the description of the specified KMS key.

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.

Returns:

Updates the description of the specified KMS key.

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.

description

public final String description()

New description for the KMS key.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Returns:

New description for the KMS key.

Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

toBuilder

public UpdateKeyDescriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateKeyDescriptionRequest.Builder,UpdateKeyDescriptionRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static UpdateKeyDescriptionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo