Container for the parameters to the TagResource operation.
Adds or edits tags on a customer
managed key.
Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details,
see ABAC
for KMS in the Key Management Service Developer Guide.
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 key, but you cannot tag an Amazon Web Services managed key, an Amazon Web Services owned key, a custom key store, or an alias.
You can also add tags to a KMS key while creating it (CreateKey) or replicating it (ReplicateKey).
For information about using tags in KMS, see Tagging keys. For general information about tags, including the format and syntax, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.
Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.
Required permissions: kms:TagResource (key policy)
Related operations
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.KeyManagementService.AmazonKeyManagementServiceRequest
Amazon.KeyManagementService.Model.TagResourceRequest
Namespace: Amazon.KeyManagementService.Model
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
Syntax
public class TagResourceRequest : AmazonKeyManagementServiceRequest IAmazonWebServiceRequest
The TagResourceRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
TagResourceRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
KeyId | System.String |
Gets and sets the property KeyId. Identifies a customer managed key in the account and Region. Specify the key ID or key ARN of the KMS key. For example:
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. |
|
|
Tags | System.Collections.Generic.List<Amazon.KeyManagementService.Model.Tag> |
Gets and sets the property 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. |
Examples
The following example tags a KMS key.
To tag a KMS key
var client = new AmazonKeyManagementServiceClient();
var response = client.TagResource(new TagResourceRequest
{
KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab", // The identifier of the KMS key you are tagging. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
Tags = new List<Tag> {
new Tag {
TagKey = "Purpose",
TagValue = "Test"
}
} // A list of tags.
});
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5