tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.security_ir.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
tags | object | Response element for ListTagsForResource providing content for each configured tag. |
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 currently configured tags on a resource. | |
tag_resource | update | resource_arn, region, tags | Adds a tag(s) to a designated resource. | |
untag_resource | update | resource_arn, tagKeys, region | Removes a tag(s) from a designate 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) |
resource_arn | string | Required element for UnTagResource to identify the ARN for the resource to remove a tag from. |
tagKeys | array | Required element for UnTagResource to identify tag to remove. |
SELECT examples
- list_tags_for_resource
Returns currently configured tags on a resource.
SELECT
tags
FROM aws.security_ir.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- tag_resource
- untag_resource
Adds a tag(s) to a designated resource.
UPDATE aws.security_ir.tags
SET
tags = '{{ tags }}'
WHERE
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;
Removes a tag(s) from a designate resource.
UPDATE aws.security_ir.tags
SET
-- No updatable properties
WHERE
resource_arn = '{{ resource_arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;