tags

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

Overview

Name	tags
Type	Resource
Id	aws.es.tags

Fields

The following fields are returned by SELECT queries:

list_tags

Name	Datatype	Description
tag_list	array	A list of Tag

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags	select	arn, region		Returns all tags for the given Elasticsearch domain.
add_tags	update	region, TagList		Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
remove_tags	update	region, TagKeys		Removes the specified set of tags from the specified Elasticsearch domain.

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
arn	string	Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.
region	string	AWS region (default: us-east-1)

SELECT examples

list_tags

Returns all tags for the given Elasticsearch domain.

SELECT
tag_list
FROM aws.es.tags
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

add_tags

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

UPDATE aws.es.tags
SET 
ARN = '{{ ARN }}',
TagList = '{{ TagList }}'
WHERE 
region = '{{ region }}' --required
AND TagList = '{{ TagList }}' --required;

remove_tags

Removes the specified set of tags from the specified Elasticsearch domain.

UPDATE aws.es.tags
SET 
ARN = '{{ ARN }}',
TagKeys = '{{ TagKeys }}'
WHERE 
region = '{{ region }}' --required
AND TagKeys = '{{ TagKeys }}' --required;