tags

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

Overview

Name	tags
Type	Resource
Id	aws.ssm_quicksetup.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	array	Key-value pairs of metadata assigned to the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	resource_arn, region		Returns tags assigned to the resource.
untag_resource	update	resource_arn, tagKeys, region		Removes tags from the specified resource.
tag_resource	update	resource_arn, region		Assigns key-value pairs of metadata to Amazon Web Services resources.

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)
resource_arn	string	The ARN of the resource to tag.
tagKeys	array	The keys of the tags to remove from the resource.

SELECT examples

list_tags_for_resource

Returns tags assigned to the resource.

SELECT
tags
FROM aws.ssm_quicksetup.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Removes tags from the specified resource.

UPDATE aws.ssm_quicksetup.tags
SET 
-- No updatable properties
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;

tag_resource

Assigns key-value pairs of metadata to Amazon Web Services resources.

UPDATE aws.ssm_quicksetup.tags
SET 
Tags = '{{ Tags }}'
WHERE 
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required;