tags
Creates, updates, deletes, gets or lists a tags resource.
Overview
| Name | tags |
| Type | Resource |
| Id | aws.elbv2.tags |
Fields
The following fields are returned by SELECT queries:
- describe_tags
| Name | Datatype | Description |
|---|---|---|
resource_arn | string | The Amazon Resource Name (ARN) of the resource. |
tags | string | Information about the tags. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_tags | select | ResourceArns, region | Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. | |
remove_tags | update | ResourceArns, TagKeys, region | Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules. | |
add_tags | update | ResourceArns, region | Tags | Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, trust stores, listeners, and rules. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value. |
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 |
|---|---|---|
ResourceArns | array | The Amazon Resource Name (ARN) of the resource. |
TagKeys | array | The tag keys for the tags to remove. |
region | string | AWS region (default: us-east-1) |
Tags | array | The tags. |
SELECT examples
- describe_tags
Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
SELECT
resource_arn,
tags
FROM aws.elbv2.tags
WHERE ResourceArns = '{{ ResourceArns }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- remove_tags
- add_tags
Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, listeners, or rules.
UPDATE aws.elbv2.tags
SET
-- No updatable properties
WHERE
ResourceArns = '{{ ResourceArns }}' --required
AND TagKeys = '{{ TagKeys }}' --required
AND region = '{{ region }}' --required
RETURNING
line_items;
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups, trust stores, listeners, and rules. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.
UPDATE aws.elbv2.tags
SET
-- No updatable properties
WHERE
ResourceArns = '{{ ResourceArns }}' --required
AND region = '{{ region }}' --required
AND Tags = '{{ Tags}}'
RETURNING
line_items;