com.amazonaws.services.kms.model

Class TagResourceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.TagResourceRequest

All Implemented Interfaces:

Serializable, Cloneable

public class TagResourceRequest
extends AmazonWebServiceRequest
implements Serializable

Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TagResourceRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getKeyId() A unique identifier for the CMK you are tagging.
List<Tag>	getTags() One or more tags.
int	hashCode()
void	setKeyId(String keyId) A unique identifier for the CMK you are tagging.
void	setTags(Collection<Tag> tags) One or more tags.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TagResourceRequest	withKeyId(String keyId) A unique identifier for the CMK you are tagging.
TagResourceRequest	withTags(Collection<Tag> tags) One or more tags.
TagResourceRequest	withTags(Tag... tags) One or more tags.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TagResourceRequest

public TagResourceRequest()

Method Detail

getKeyId

public String getKeyId()

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.

Constraints:
Length: 1 - 2048

Returns:

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.

setKeyId

public void setKeyId(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.

Constraints:
Length: 1 - 2048

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.

withKeyId

public TagResourceRequest withKeyId(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.

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

Constraints:
Length: 1 - 2048

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:

A reference to this updated object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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

Returns:

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

setTags

public void setTags(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.

withTags

public TagResourceRequest withTags(Tag... tags)

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

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

Parameters:

tags -

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

Returns:

A reference to this updated object so that method calls can be chained together.

withTags

public TagResourceRequest withTags(Collection<Tag> tags)

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

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

Parameters:

tags -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object