tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.controltower.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
tags | object | A list of tags, as key:value strings. |
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 a list of tags associated with the resource. For usage examples, see the Controls Reference Guide . | |
tag_resource | update | resource_arn, region, tags | Applies tags to a resource. For usage examples, see the Controls Reference Guide . | |
untag_resource | update | resource_arn, tagKeys, region | Removes tags from a resource. For usage examples, see the Controls Reference Guide . |
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. |
tagKeys | array | Tag keys to be removed from the resource. |
SELECT examples
- list_tags_for_resource
Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
SELECT
tags
FROM aws.controltower.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- tag_resource
- untag_resource
Applies tags to a resource. For usage examples, see the Controls Reference Guide .
UPDATE aws.controltower.tags
SET
tags = '{{ tags }}'
WHERE
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;
Removes tags from a resource. For usage examples, see the Controls Reference Guide .
UPDATE aws.controltower.tags
SET
-- No updatable properties
WHERE
resource_arn = '{{ resource_arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;