tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.ssm_incidents.tags |
Fields
The following fields are returned by SELECT queries:
- list_tags_for_resource
| Name | Datatype | Description |
|---|---|---|
tags | object | A list of tags for the response plan or incident. |
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 | Lists the tags that are attached to the specified response plan or incident. | |
tag_resource | update | resource_arn, region, tags | Adds a tag to a response plan. | |
untag_resource | update | resource_arn, tagKeys, region | Removes a tag from 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 Amazon Resource Name (ARN) of the response plan you're removing a tag from. |
tagKeys | array | The name of the tag to remove from the response plan. |
SELECT examples
- list_tags_for_resource
Lists the tags that are attached to the specified response plan or incident.
SELECT
tags
FROM aws.ssm_incidents.tags
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- tag_resource
- untag_resource
Adds a tag to a response plan.
UPDATE aws.ssm_incidents.tags
SET
tags = '{{ tags }}'
WHERE
resource_arn = '{{ resource_arn }}' --required
AND region = '{{ region }}' --required
AND tags = '{{ tags }}' --required;
Removes a tag from a resource.
UPDATE aws.ssm_incidents.tags
SET
-- No updatable properties
WHERE
resource_arn = '{{ resource_arn }}' --required
AND tagKeys = '{{ tagKeys }}' --required
AND region = '{{ region }}' --required;