software.amazon.awssdk.services.kms.model

Interface UpdateKeyDescriptionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateKeyDescriptionRequest.Builder,UpdateKeyDescriptionRequest>, KmsRequest.Builder, SdkBuilder<UpdateKeyDescriptionRequest.Builder,UpdateKeyDescriptionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateKeyDescriptionRequest

public static interface UpdateKeyDescriptionRequest.Builder
extends KmsRequest.Builder, SdkPojo, CopyableBuilder<UpdateKeyDescriptionRequest.Builder,UpdateKeyDescriptionRequest>

Method Summary

Modifier and Type	Method and Description
UpdateKeyDescriptionRequest.Builder	description(String description) New description for the KMS key.
UpdateKeyDescriptionRequest.Builder	keyId(String keyId) Updates the description of the specified KMS key.
UpdateKeyDescriptionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateKeyDescriptionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

keyId

UpdateKeyDescriptionRequest.Builder keyId(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

description

UpdateKeyDescriptionRequest.Builder description(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

UpdateKeyDescriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdateKeyDescriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder