tags

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

Overview

Name	tags
Type	Resource
Id	aws.backup_gateway.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
resource_arn	string	The Amazon Resource Name (ARN) of the resource's tags that you listed. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):backup-gateway(:[a-zA-Z-0-9]+){3}/[a-zA-Z-0-9]+</code>)
tags	array	A list of the resource's tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_tags_for_resource	select	region		Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).
untag_resource	update	region, ResourceARN, TagKeys		Removes tags from the resource.
tag_resource	update	region, ResourceARN		Tag the 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

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

SELECT
resource_arn,
tags
FROM aws.backup_gateway.tags
WHERE region = '{{ region }}' -- required
;

UPDATE examples

untag_resource

Removes tags from the resource.

UPDATE aws.backup_gateway.tags
SET 
ResourceARN = '{{ ResourceARN }}',
TagKeys = '{{ TagKeys }}'
WHERE 
region = '{{ region }}' --required
AND ResourceARN = '{{ ResourceARN }}' --required
AND TagKeys = '{{ TagKeys }}' --required
RETURNING
resource_arn;

tag_resource

Tag the resource.

UPDATE aws.backup_gateway.tags
SET 
ResourceARN = '{{ ResourceARN }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND ResourceARN = '{{ ResourceARN }}' --required
RETURNING
resource_arn;