tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.datasync.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
key | string | The key for an Amazon Web Services resource tag. (pattern: <code>^[a-zA-Z0-9\s+=._:/-]+$</code>) |
value | string | The value for an Amazon Web Services resource tag. (pattern: <code>^[a-zA-Z0-9\s+=._:@/-]+$</code>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_tags_for_resource | select | region | Returns all the tags associated with an Amazon Web Services resource. | |
tag_resource | update | region, ResourceArn, Tags | Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources. These include DataSync resources, such as locations, tasks, and task executions. | |
untag_resource | update | region, ResourceArn, Keys | Removes tags from an Amazon Web Services 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 all the tags associated with an Amazon Web Services resource.
SELECT
key,
value
FROM aws.datasync.tags
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- tag_resource
- untag_resource
Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources. These include DataSync resources, such as locations, tasks, and task executions.
UPDATE aws.datasync.tags
SET
ResourceArn = '{{ ResourceArn }}',
Tags = '{{ Tags }}'
WHERE
region = '{{ region }}' --required
AND ResourceArn = '{{ ResourceArn }}' --required
AND Tags = '{{ Tags }}' --required;
Removes tags from an Amazon Web Services resource.
UPDATE aws.datasync.tags
SET
ResourceArn = '{{ ResourceArn }}',
Keys = '{{ Keys }}'
WHERE
region = '{{ region }}' --required
AND ResourceArn = '{{ ResourceArn }}' --required
AND Keys = '{{ Keys }}' --required;