tags

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

Overview

Name	tags
Type	Resource
Id	aws.pcs.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		Returns a list of all tags on an PCS resource.
tag_resource	update	region, resourceArn, tags		Adds or edits tags on an PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value 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.
untag_resource	update	region, resourceArn, tagKeys		Deletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS 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
region	string	AWS region (default: us-east-1)

SELECT examples

list_tags_for_resource

Returns a list of all tags on an PCS resource.

SELECT
tags
FROM aws.pcs.tags
WHERE region = '{{ region }}' -- required
;

UPDATE examples

tag_resource

Adds or edits tags on an PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value 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.

UPDATE aws.pcs.tags
SET 
resourceArn = '{{ resourceArn }}',
tags = '{{ tags }}'
WHERE 
region = '{{ region }}' --required
AND resourceArn = '{{ resourceArn }}' --required
AND tags = '{{ tags }}' --required;

untag_resource

Deletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS resource.

UPDATE aws.pcs.tags
SET 
resourceArn = '{{ resourceArn }}',
tagKeys = '{{ tagKeys }}'
WHERE 
region = '{{ region }}' --required
AND resourceArn = '{{ resourceArn }}' --required
AND tagKeys = '{{ tagKeys }}' --required;