tags

Creates, updates, deletes, gets or lists a tags resource.

Overview

Name	tags
Type	Resource
Id	aws.docdb.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
key	string	The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-]*)$").
value	string	The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-]*)$").

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	ResourceName, region	Filters	Lists all tags on an Amazon DocumentDB resource.
add_tags_to_resource	update	ResourceName, Tags, region		Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.
remove_tags_from_resource	update	ResourceName, TagKeys, region		Removes metadata tags from an Amazon DocumentDB resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
ResourceName	string	The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).
TagKeys	array	The tag key (name) of the tag to be removed.
Tags	array	The tags to be assigned to the Amazon DocumentDB resource.
region	string	AWS region (default: us-east-1)
Filters	array	This parameter is not currently supported.

SELECT examples

list_tags_for_resource

Lists all tags on an Amazon DocumentDB resource.

SELECT
key,
value
FROM aws.docdb.tags
WHERE ResourceName = '{{ ResourceName }}' -- required
AND region = '{{ region }}' -- required
AND Filters = '{{ Filters }}'
;

UPDATE examples

add_tags_to_resource

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.

UPDATE aws.docdb.tags
SET 
-- No updatable properties
WHERE 
ResourceName = '{{ ResourceName }}' --required
AND Tags = '{{ Tags }}' --required
AND region = '{{ region }}' --required;

remove_tags_from_resource

Removes metadata tags from an Amazon DocumentDB resource.

UPDATE aws.docdb.tags
SET 
-- No updatable properties
WHERE 
ResourceName = '{{ ResourceName }}' --required
AND TagKeys = '{{ TagKeys }}' --required
AND region = '{{ region }}' --required;