tags

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

Overview

Name	tags
Type	Resource
Id	aws.securityhub.tags

Fields

The following fields are returned by SELECT queries:

list_tags_for_resource

Name	Datatype	Description
tags	object	The tags associated with a 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 a list of tags associated with a resource.
untag_resource	update	resource_arn, tagKeys, region		Removes one or more tags from a resource.
tag_resource	update	resource_arn, region		Adds one or more tags to a 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	The ARN of the resource to apply the tags to.
tagKeys	array	The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.

SELECT examples

list_tags_for_resource

Returns a list of tags associated with a resource.

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

UPDATE examples

untag_resource

Removes one or more tags from a resource.

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

tag_resource

Adds one or more tags to a resource.

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