TagResourceRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.TagResourceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class TagResourceRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Adds or edits tags on a customer managed CMK.

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string.

To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

You can use this operation to tag a customer managed CMK, but you cannot tag an AWS managed CMK, an AWS owned CMK, or an alias.

For general information about tags, including the format and syntax, see Tagging AWS resources in the Amazon Web Services General Reference. For information about using tags in AWS KMS, see Tagging keys.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:TagResource (key policy)

Related operations
- UntagResource
- ListResourceTags
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

TagResourceRequest()

Constructors
Constructor and Description
`TagResourceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getKeyId()` Identifies a customer managed CMK in the account and Region.
`java.util.List<Tag>`	`getTags()` One or more tags.
`int`	`hashCode()`
`void`	`setKeyId(java.lang.String keyId)` Identifies a customer managed CMK in the account and Region.
`void`	`setTags(java.util.Collection<Tag> tags)` One or more tags.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TagResourceRequest`	`withKeyId(java.lang.String keyId)` Identifies a customer managed CMK in the account and Region.
`TagResourceRequest`	`withTags(java.util.Collection<Tag> tags)` One or more tags.
`TagResourceRequest`	`withTags(Tag... tags)` One or more tags.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TagResourceRequest
```
public TagResourceRequest()
```
- Method Detail
  - getKeyId
```
public java.lang.String getKeyId()
```
    Identifies a customer managed CMK in the account and Region.
    
    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:
    Identifies a customer managed CMK in the account and Region.
    
    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(java.lang.String keyId)
```
    Identifies a customer managed CMK in the account and Region.
    
    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 -
    Identifies a customer managed CMK in the account and Region.
    
    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(java.lang.String keyId)
```
    Identifies a customer managed CMK in the account and Region.
    
    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 -
    Identifies a customer managed CMK in the account and Region.
    
    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 java.util.List<Tag> getTags()
```
    One or more tags.
    
    Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    Returns:
    
    One or more tags.
    
    Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
  - setTags
```
public void setTags(java.util.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.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS 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.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
  - withTags
```
public TagResourceRequest withTags(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.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    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. The tag value can be an empty (null) string.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withTags
```
public TagResourceRequest withTags(java.util.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.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    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. The tag value can be an empty (null) string.
    
    You cannot have more than one tag on a CMK with the same tag key. If you specify an existing tag key with a different tag value, AWS KMS replaces the current tag value with the specified one.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class TagResourceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

TagResourceRequest

Method Detail

getKeyId

setKeyId

withKeyId

getTags

setTags

withTags

withTags

toString

hashCode

equals