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

Interface TagResourceRequest.Builder

    • Method Detail

      • 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).

        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:
        #tags(java.util.Collection)