为 Amazon DocumentDB 资源添加标签

可以使用 Amazon DocumentDB（与 MongoDB 兼容） 标签向您的 Amazon DocumentDB 资源添加元数据。这些标签可与 AWS Identity and Access Management (IAM) 策略结合使用，以管理对 Amazon DocumentDB 资源的访问并控制可将什么操作应用于资源。您还可以将具有类似标签的资源的费用分组在一起，使用标签来跟踪成本。

您可以为以下 Amazon DocumentDB 资源添加标签：

  • 集群

  • 实例

  • 快照

  • 集群快照

  • 参数组

  • 集群参数组

  • 安全组

  • 子网组

Amazon DocumentDB 资源标签概述

Amazon DocumentDB 标签是由您定义的名称-值对，与某种 Amazon DocumentDB 资源关联。此名称也叫键。为键提供值为可选操作。可使用标签向 Amazon DocumentDB 资源分配任意信息。例如，您可以使用标签键定义一个类别，而标签值可以是该类别中的一个项目。例如，通过定义标签键 project 和标签值 Salix，可以表示将 Amazon DocumentDB 资源分配给 Salix 项目。您也可以使用标签通过 environment=test 或 environment=production 等键指定 Amazon DocumentDB 资源用于测试或生产。我们建议使用一组具有一致性的标签键，以使跟踪与 Amazon DocumentDB 资源关联的元数据变得更轻松。

您可以使用标签来管理 AWS 账单，使其反映您的成本结构。要执行此操作，请注册以获取包含标签键值的 AWS 账户账单。然后，如需查看组合资源的成本，请按有同样标签键值的资源组织您的账单信息。例如，您可以将特定的应用程序名称用作几个资源的标签，然后组织账单信息，以查看在数个服务中的使用该应用程序的总成本。有关更多信息，请参阅 AWS 账单和成本管理用户指南 中的使用成本分配标签。

每个 Amazon DocumentDB 资源都有一组标签，其中包含分配给该资源的所有标签。一个标签集可以包含多达 10 个标签，也可以为空。如果向 Amazon DocumentDB 资源添加一个标签，而该标签的键与资源上某个现有的标签相同，则新值将覆盖旧值。

AWS 不会对您的标签应用任何语义意义；所有标签都会严格地作为字符串进行解析。Amazon DocumentDB 可以在实例或其他 Amazon DocumentDB 资源上设置标签，这取决于您创建资源时使用的设置。例如，Amazon DocumentDB 可能添加一个标签来指示实例用于生产或测试。

您可以将标签添加到快照中，但您的账单不会反映此分组。

您可以使用 AWS 管理控制台 或 AWS CLI 添加、列出和删除 Amazon DocumentDB 资源上的标签。使用 AWS CLI 时，必须提供要使用的资源的 Amazon 资源名称 (ARN)。有关 Amazon DocumentDB ARN 的更多信息，请参阅 了解 Amazon DocumentDB Amazon 资源名称 (ARN)。

标签约束

以下约束适用于 Amazon DocumentDB 标签：

  • 每个资源的最大标签数 - 10

  • 最大键长度 - 128 个 Unicode 字符

  • 最大值长度 - 256 个 Unicode 字符

  • 键和值的有效字符 - UTF-8 字符集中的大写和小写字母、位、空格及以下字符：_ . : / = + - 和 @ (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$")

  • 标签键和值要区分大小写。

  • 前缀 aws: 无法用于标签键或值；将其保留供 AWS 使用。

为 Amazon DocumentDB 资源添加和更新标签

使用 AWS 管理控制台 或 AWS CLI，您最多可以向资源添加 10 个标签。

使用 AWS 管理控制台

无论您将标签添加到哪个资源，向资源添加标签的过程都是相似的。在本示例中，您向集群添加标签。

要使用控制台向集群添加标签或更新标签

  1. 通过以下网址登录 AWS 管理控制台并打开 Amazon DocumentDB 控制台：https://console.aws.amazon.com/docdb。

  2. 从导航窗格中，选择集群。

  3. 选择要将标签添加到的集群的名称。

  4. 向下滚动到标签部分，然后选择 编辑。

  5. 对于每个要添加到此资源的标签，请执行以下操作：

    1. 要添加新标签，请在值框中输入标签的名称。要更改标签的值，请在值列中找到标签的名称。

    2. 要赋予标签新建或更新的值，在值框中，为标签输入一个值。

    3. 如果要添加多个标签，请选择添加。否则，完成后，选择保存。

使用 AWS CLI

无论您将标签添加到哪个资源，向资源添加标签的过程都是相似的。在本示例中，您向集群添加三个标签。第二个标签 key2 没有值。

使用带有这些参数的 AWS CLI 操作 add-tags-to-resource。

参数

  • --resource-name — 要将标签添加到的 Amazon DocumentDB 资源的 ARN。

  • --tags — 要添加到格式为 Key=`key-name`,Value=`tag-value` 的此资源的标签（键/值对）的列表。

对于 Linux、macOS 或 Unix:

  1. aws docdb add-tags-to-resource \
  2.     --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
  3.     --tags Key=key1,Value=value1 Key=key2 Key=key3,Value=value3

对于 Windows:

  1. aws docdb add-tags-to-resource ^
  2.     --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
  3.     --tags Key=key1,Value=value1 Key=key2 Key=key3,Value=value3

此 add-tags-to-resource 操作不会生成任何输出。要查看操作结果，请使用 list-tags-for-resource 操作。

列出 Amazon DocumentDB 资源上的标签

您可以使用 AWS 管理控制台 或 AWS CLI 获取 Amazon DocumentDB 资源的标签列表。

使用 AWS 管理控制台

无论您将标签添加到哪个资源，在资源上列出标签的过程都是相似的。在本示例中，您为集群列出标签。

要使用控制台列出集群上的标签

  1. 从 https://console.aws.amazon.com/docdb 打开 Amazon DocumentDB 控制台。

  2. 从导航窗格中，选择集群。

  3. 选择要为之列出标签的集群的名称。

  4. 要查看此资源上的标签列表，向下滚动到标签部分。

使用 AWS CLI

无论您为哪个资源列出标签，在资源上列出标签的过程都是相似的。在本示例中，您在集群上列出标签。

使用带有这些参数的 AWS CLI 操作 list-tags-for-resource。

参数

  • --resource-name — 必需。您要列出其标签的 Amazon DocumentDB 资源的 ARN。

对于 Linux、macOS 或 Unix:

  1. aws docdb list-tags-for-resource \
  2.     --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster

对于 Windows:

  1. aws docdb list-tags-for-resource ^
  2.     --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster

此操作的输出将类似于下文（JSON 格式）。

  1. {
  2.     "TagList": [
  3.         {
  4.             "Key": "key1",
  5.             "Value": "value1"
  6.         },
  7.         {
  8.             "Key": "key2",
  9.             "Value": ""
  10.         },
  11.         {
  12.             "Key": "key3",
  13.             "Value": "value3"
  14.         }
  15.     ]
  16. }

删除 Amazon DocumentDB 资源的标签

可以使用 AWS 管理控制台 或 AWS CLI 从 Amazon DocumentDB 资源中删除标签。

使用 AWS 管理控制台

无论您将标签添加到哪个资源，从资源中删除标签的过程都是相似的。在本示例中，您从集群中删除标签。

使用控制台从集群中删除标签

  1. 从 https://console.aws.amazon.com/docdb 打开 Amazon DocumentDB 控制台。

  2. 从导航窗格中，选择集群。

  3. 选择要从中删除标签的集群的名称。

  4. 向下滚动到标签部分，然后选择 编辑。

  5. 如果您要从该资源中删除所有标签，请选择 Remove all （删除所有）。否则，对于每个要从此资源删除的标签，请执行以下操作：

    1. 查找键列中的标签的名称。

    2. 在同一行上选择删除作为标签值。

    3. 完成后，选择保存。

使用 AWS CLI

无论您从哪个资源删除标签，从资源中删除标签的过程都是相似的。在本示例中，您从集群中删除标签。

使用带有这些参数的 AWS CLI 操作 remove-tags-from-resource。

  • --resource-name — 必需。要从中删除标签的 Amazon DocumentDB 资源的 ARN。

  • --tag-keys — 必需。要从此资源中删除的标签值列表。

对于 Linux、macOS 或 Unix:

  1. aws docdb remove-tags-from-resource \
  2.     --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
  3.     --tag-keys key1 key3

对于 Windows:

  1. aws docdb remove-tags-from-resource ^
  2.     --resource-name arn:aws:rds:us-east-1:1234567890:cluster:sample-cluster \
  3.     --tag-keys key1 key3

此 removed-tags-from-resource 操作不会生成任何输出。要查看操作结果，请使用 list-tags-for-resource 操作。