tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.bcm_dashboards.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
resource_tags | array | The list of tags associated with the specified dashboard resource. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_tags_for_resource | select | region | Returns a list of all tags associated with a specified dashboard resource. | |
tag_resource | update | region, resourceArn, resourceTags | Adds or updates tags for a specified dashboard resource. | |
untag_resource | update | region, resourceArn, resourceTagKeys | Removes specified tags from a dashboard 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
Returns a list of all tags associated with a specified dashboard resource.
SELECT
resource_tags
FROM aws.bcm_dashboards.tags
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- tag_resource
- untag_resource
Adds or updates tags for a specified dashboard resource.
UPDATE aws.bcm_dashboards.tags
SET
resourceArn = '{{ resourceArn }}',
resourceTags = '{{ resourceTags }}'
WHERE
region = '{{ region }}' --required
AND resourceArn = '{{ resourceArn }}' --required
AND resourceTags = '{{ resourceTags }}' --required;
Removes specified tags from a dashboard resource.
UPDATE aws.bcm_dashboards.tags
SET
resourceArn = '{{ resourceArn }}',
resourceTagKeys = '{{ resourceTagKeys }}'
WHERE
region = '{{ region }}' --required
AND resourceArn = '{{ resourceArn }}' --required
AND resourceTagKeys = '{{ resourceTagKeys }}' --required;