software.amazon.awssdk.services.kms.model

Interface UpdateAliasRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>, KMSRequest.Builder, SdkBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>, SdkRequest.Builder

Enclosing class:

UpdateAliasRequest

public static interface UpdateAliasRequest.Builder
extends KMSRequest.Builder, CopyableBuilder<UpdateAliasRequest.Builder,UpdateAliasRequest>

Method Summary

Modifier and Type	Method and Description
UpdateAliasRequest.Builder	aliasName(String aliasName) String that contains the name of the alias to be modified.
UpdateAliasRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
UpdateAliasRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
UpdateAliasRequest.Builder	targetKeyId(String targetKeyId) Unique identifier of the customer master key to be mapped to the alias.

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

build

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

requestOverrideConfig

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

copy

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

apply, build

Method Detail

aliasName

UpdateAliasRequest.Builder aliasName(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.

Parameters:

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:

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

targetKeyId

UpdateAliasRequest.Builder targetKeyId(String targetKeyId)

Unique identifier of the customer master key to be mapped to the alias.

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.

Parameters:

targetKeyId - Unique identifier of the customer master key to be mapped to the alias.

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.

Returns:

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

requestOverrideConfig

UpdateAliasRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

UpdateAliasRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.