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

Interface TagResourceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>, KmsRequest.Builder, SdkBuilder<TagResourceRequest.Builder,TagResourceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
TagResourceRequest
public static interface TagResourceRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<TagResourceRequest.Builder,TagResourceRequest>

  • Method Details

    • keyId

      TagResourceRequest.Builder keyId(String keyId)

      Identifies a customer managed key in the account and Region.

      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 - Identifies a customer managed key in the account and Region.

      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.

    • tags

      TagResourceRequest.Builder tags(Collection<Tag> tags)

      One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

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

      You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

      Parameters:
      tags - One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

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

      You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

      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. The tag value can be an empty (null) string.

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

      You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

      Parameters:
      tags - One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.

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

      You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

      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. The tag value can be an empty (null) string.

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

      You cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      TagResourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      TagResourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.