software.amazon.awssdk.services.kms.model

Interface TagResourceRequest.Builder

All Superinterfaces:

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

Enclosing class:

TagResourceRequest

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

Method Summary

Modifier and Type	Method and Description
TagResourceRequest.Builder	keyId(String keyId) A unique identifier for the CMK you are tagging.
TagResourceRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
TagResourceRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
TagResourceRequest.Builder	tags(Collection<Tag> tags) One or more tags.
TagResourceRequest.Builder	tags(Consumer<Tag.Builder>... tags) One or more tags.
TagResourceRequest.Builder	tags(Tag... tags) One or more tags.

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

keyId

TagResourceRequest.Builder keyId(String keyId)

A unique identifier for the CMK you are tagging.

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.

Parameters:

keyId - A unique identifier for the CMK you are tagging.

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.

Returns:

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

tags

TagResourceRequest.Builder tags(Collection<Tag> tags)

One or more tags. Each tag consists of a tag key and a tag value.

Parameters:

tags - One or more tags. Each tag consists of a tag key and a tag value.

Returns:

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

tags

TagResourceRequest.Builder tags(Tag... tags)

One or more tags. Each tag consists of a tag key and a tag value.

Parameters:

tags - One or more tags. Each tag consists of a tag key and a tag value.

Returns:

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

tags

TagResourceRequest.Builder tags(Consumer<Tag.Builder>... tags)

One or more tags. Each tag consists of a tag key and a tag value.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tags(List)

requestOverrideConfig

TagResourceRequest.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

TagResourceRequest.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.