Skip to main content

tags

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

Overview

Nametags
TypeResource
Idaws.neptune.tags

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
keystringA key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-]*)$").
valuestringA value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}.:/=+\-]*)$").

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_tags_for_resourceselectResourceName, regionFiltersLists all tags on an Amazon Neptune resource.
add_tags_to_resourceupdateResourceName, Tags, regionAdds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.
remove_tags_from_resourceupdateResourceName, TagKeys, regionRemoves metadata tags from an Amazon Neptune 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.

NameDatatypeDescription
ResourceNamestringThe Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).
TagKeysarrayThe tag key (name) of the tag to be removed.
TagsarrayThe tags to be assigned to the Amazon Neptune resource.
regionstringAWS region (default: us-east-1)
FiltersarrayThis parameter is not currently supported.

SELECT examples

Lists all tags on an Amazon Neptune resource.

SELECT
key,
value
FROM aws.neptune.tags
WHERE ResourceName = '{{ ResourceName }}' -- required
AND region = '{{ region }}' -- required
AND Filters = '{{ Filters }}'
;

UPDATE examples

Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

UPDATE aws.neptune.tags
SET
-- No updatable properties
WHERE
ResourceName = '{{ ResourceName }}' --required
AND Tags = '{{ Tags }}' --required
AND region = '{{ region }}' --required;