构建查询和组Amazon Resource Groups - Amazon Resource Groups和标签
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

构建查询和组Amazon Resource Groups

资源组查询的类型

InAmazon Resource Groups,aquery是基于查询的组的基础。您可以将资源组基于两种类型的查询之一。

基于标签

基于标签的查询包含使用以下格式指定的资源类型列表AWS::service::resource和标签。标签 是帮助识别组织中的资源以及对其进行排序的键。(可选)标签包含键的值。

对于基于标签的查询,您还可以指定要作为组成员的资源共享的标签。例如,如果要创建的资源组具有用于运行应用程序测试阶段的所有 Amazon EC2 实例和 Amazon 存储桶,并且您具有以这种方式标记的实例和存储桶,请选择AWS::EC2::InstanceAWS::S3::Bucket资源类型,然后在下拉列表中指定标签键Stage,标签值为Test.

语法ResourceQuery参数包含以下元素:

  • Type

    此元素指示定义此资源组的查询类型。要创建基于标签的资源组,请指定TAG_FILTERS_1_0, 如下所示:

    "Type": "TAG_FILTERS_1_0"
  • Query

    此元素定义了用于匹配资源的实际查询。它包含具有以下元素的 JSON 结构的字符串表示形式:

    • ResourceTypeFilters

      此元素将结果限制为仅与筛选器匹配的资源类型。可以指定以下值:

      • "AWS::AllSupported"— 指定结果可以包含与查询匹配且 &ARG; 服务当前支持的任何类型的资源。

      • "AWS::service-id::resource-type— 以逗号分隔的资源类型规范字符串列表,格式为:,例如"AWS::EC2::Instance".

    • TagFilters

      此元素指定与附加到资源的标签进行比较的键/值字符串对。具有与筛选器匹配的标签键和值的用户将包括在组中。每个过滤器由以下元素组成:

      • "Key"― 带有键名称的字符串。只有具有匹配键名称的标签的资源匹配并且可以包含在组中。

      • "Values"― 指定键的值列表以逗号分隔的字符串。只有具有匹配标签键和与此列表中的值匹配的资源才是组的成员。

所有这些 JSON 元素都必须组合成 JSON 结构的单行字符串表示形式。例如,考虑使用Query使用以下示例 JSON 结构。此查询仅用于匹配带有标签 “Stage” 和值 “Test” 的 Amazon EC2 实例。

{ "ResourceTypeFilters": [ "AWS::EC2::Instance" ], "TagFilters": [ { "Key": "Stage", "Values": [ "Test" ] } ] }

该 JSON 可以表示为以下单行字符串,并用作Query元素。由于 JSON 结构的值必须是双引号字符串,因此必须在每个字符之前加上反斜杠来转义任何嵌入的双引号字符或正斜杠字符,如下所示:

"Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"

完成ResourceQuery字符串被表示为 CLI 命令参数:

--resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'
Amazon CloudFormation 基于 堆栈

在基于 Amazon CloudFormation 堆栈的查询中,您可以在您的账户的当前区域中选择一个 Amazon CloudFormation 堆栈,然后在该堆栈中选择要包含在组中的资源类型。您只能将查询基于一个 Amazon CloudFormation 堆栈。Resource Groups 支持基于Amazon CloudFormation具有以下其中一种状态的堆栈。

重要

只有在查询中直接创建为堆栈的一部分的资源才会包含在资源组中。以后由Amazon CloudFormation堆栈不会成为组的成员。例如,如果 auto-scaling 组是由Amazon CloudFormation作为堆栈的一部分,那么该 auto-scaling 组该组的成员。但是,由该 auto-scaling 组创建的 Amazon EC2 实例作为其操作的一部分不是的成员Amazon CloudFormation基于堆栈的资源组。

如果您创建基于Amazon CloudFormation堆栈,并且该堆栈变为不再支持作为组查询基础的状态(如DELETE_COMPLETE,资源组仍然存在,但它没有成员资源。

创建资源组后,您可以对组中的资源执行任务。

语法ResourceQuery参 CloudFormation 以下元素:

  • Type

    此元素指示定义此资源组的查询类型。

    创建Amazon CloudFormation基于堆栈的资源组,请指定值CLOUDFORMATION_STACK_1_0, 如下所示:

    "Type": "CLOUDFORMATION__STACK_1_0"
  • Query

    此元素定义了用于匹配资源的实际查询。它包含具有以下元素的 JSON 结构的字符串表示形式:

    • ResourceTypeFilters

      此元素将结果限制为仅与筛选器匹配的资源类型。可以指定以下值:

      • "AWS::AllSupported"― 指定结果可以包含与查询匹配的任何类型的资源。

      • "AWS::service-id::resource-type— 以逗号分隔的资源类型规范字符串列表,格式为:,例如"AWS::EC2::Instance".

    • StackIdentifier

      此元素指定Amazon CloudFormation堆栈,您想要包含在组中的资源。

所有这些 JSON 元素都必须组合成 JSON 结构的单行字符串表示形式。例如,考虑使用Query使用以下示例 JSON 结构。此查询旨在 Amazon S3 匹配属于指定Amazon CloudFormation堆栈。

{ "ResourceTypeFilters": [ "AWS::S3::Bucket" ], "StackIdentifier": "arn:aws:cloudformation:us-west-2:123456789012:stack/MyCloudFormationStackName/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE" }

该 JSON 可以表示为以下单行字符串,并用作Query元素。由于 JSON 结构的值必须是双引号字符串,因此必须在每个字符之前加上反斜杠来转义任何嵌入的双引号字符或正斜杠字符,如下所示:

"Query":"{\"ResourceTypeFilters\":[\"AWS::S3::Bucket"\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack\/MyCloudFormationStackName\/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE\"

完成ResourceQuery字符串被表示为 CLI 命令参数:

--resource-query '{"Type":"CLOUDFORMATION__STACK_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::S3::Bucket"\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack\/MyCloudFormationStackName\/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE\"}'

构建基于标签的查询和创建组

以下过程说明了如何构建基于标签的查询以及如何使用它创建资源组。

Console
  1. 登录到 Amazon Resource Groups 控制台

  2. 在导航窗格中,选择创建资源组.

  3. 在存储库的创建基于查询的组页面,在Group type中,选择基于标签组类型。

  4. UNDERGroup type下,选择您想要加入资源组中的资源类型。您最多可以在查询中包含 20 种资源类型。在本演练中,选择AWS::EC2::InstanceAWS::S3::Bucket.

  5. 仍然在下Group type, 用于标签中,指定标签键或标签键和值对,以将匹配资源限制为仅标记有您指定的值的资源。在完成您的标签时,请选择 Add (添加) 或按 Enter。在该示例中,筛选具有 Stage 标签键的资源。标签值是可选的,但会进一步缩小查询的结果。您可以为标签键添加多个值OR运算符。要添加更多标签,请选择添加。查询将 AND 运算符分配给标签,以便与指定的资源类型和所有指定标签匹配的任何资源都将由查询返回。

  6. 仍然在下Group type中,选择预览组资源返回您账户中与一个或多个指定标签键匹配的 EC2 实例和 S3 存储桶列表。

  7. 获得所需结果后,根据此查询创建一个组。

    1. UNDER组详细信息, 用于Group name下,为您的资源组键入名称。

      资源组名称最多可以包含 128 个字符,包括字母、数字、连字符、句点和下划线。名称不能以 AWSaws 开头。这些名称是预留的。资源组名称在您账户的当前区域中必须是唯一的。

    2. (可选)在组描述中,输入您的组的描述。

    3. (可选)在组标签中,添加仅适用于资源组(而不适用于组中的成员资源)的标签键和值对。

      如果计划将此组作为较大组的成员,则组标签非常有用。由于需要指定至少一个标签键以创建组,因此,请务必将组标签中的至少一个标签键添加到打算嵌套到更大组的组中。

  8. 完成后,选择创建组.

Amazon CLI & Amazon SDKs

基于标签的组基于 TAG_FILTERS_1_0 类型的查询。

  1. 在 Amazon CLI 会话中,键入以下内容,然后按 Enter,以将组名称、描述、资源类型、标签键和标签值替换为您自己的值。描述最多可以包含 512 个字符,包括字母、数字、连字符、下划线、标点符号和空格。您最多可以在查询中包含 20 种资源类型。资源组名称最多可以包含 128 个字符,包括字母、数字、连字符、句点和下划线。名称不能以 AWSaws 开头。这些名称是预留的。资源组名称在您的账户中必须是唯一的。

    需要使用至少一个 ResourceTypeFilters 值。要指定所有资源类型,请将 AWS::AllSupported 作为 ResourceTypeFilters 值。

    $ aws resource-groups create-group \ --name resource-group-name \ --resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"resource_type1\",\"resource_type2\"],\"TagFilters\":[{\"Key\":\"Key1\",\"Values\":[\"Value1\",\"Value2\"]},{\"Key\":\"Key2\",\"Values\":[\"Value1\",\"Value2\"]}]}"}'

    以下命令是一个示例。

    $ aws resource-groups create-group \ --name my-resource-group \ --resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'

    以下命令是一个示例,其中包含所有支持的资源类型。

    $ aws resource-groups create-group \ --name my-resource-group \ --resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'
  2. 在对命令的响应中返回以下内容。

    • 您创建的组的完整描述。

    • 您用于创建组的资源查询。

    • 与组关联的标签。

创建Amazon CloudFormation基于堆栈的组

以下过程说明了如何构建基于堆栈的查询以及如何使用它创建资源组。

Console
  1. 登录到 Amazon Resource Groups 控制台

  2. 在导航窗格中,选择创建资源组.

  3. 在 上创建基于查询的组,在Group type中,选择基于 CloudFormation 堆栈组类型。

  4. 选择要作为组基础的堆栈。只能将资源组基于一个堆栈。要筛选堆栈列表,请开始键入堆栈的名称。仅在列表中显示具有支持的状态的堆栈。

  5. 在堆栈中选择要包含在组中的资源类型。对于本演练,请保留默认值所有受支持的资源类型。有关可以包含在组中的受支持资源类型的更多信息,请参阅你可以使用的资源Amazon Resource Groups标签编辑器

  6. 选择查看组资源以返回 Amazon CloudFormation 堆栈中与选定资源类型匹配的资源列表。

  7. 获得所需结果后,根据此查询创建一个组。

    1. UNDER组详细信息, 用于Group name下,为您的资源组键入名称。

      资源组名称最多可以包含 128 个字符,包括字母、数字、连字符、句点和下划线。名称不能以 AWSaws 开头。这些名称是预留的。资源组名称在您账户的当前区域中必须是唯一的。

    2. (可选)在组描述中,输入您的组的描述。

    3. (可选)在组标签中,添加仅适用于资源组(而不适用于组中的成员资源)的标签键和值对。

      如果计划将此组作为较大组的成员,则组标签非常有用。由于需要指定至少一个标签键以创建组,因此,请务必将组标签中的至少一个标签键添加到打算嵌套到更大组的组中。

  8. 完成后,选择创建组.

Amazon CLI & Amazon SDKs

基于 Amazon CloudFormation 堆栈的组基于 CLOUDFORMATION_STACK_1_0 类型的查询。

  1. 运行以下命令,以将组名称、描述、堆栈标识符和资源类型替换为您自己的值。描述最多可以包含 512 个字符,包括字母、数字、连字符、下划线、标点符号和空格。

    如果未指定资源类型,Resource Groups 将包含堆栈中的所有支持的资源类型。您最多可以在查询中包含 20 种资源类型。资源组名称最多可以包含 128 个字符,包括字母、数字、连字符、句点和下划线。名称不能以 AWSaws 开头。这些名称是预留的。资源组名称在您的账户中必须是唯一的。

    stack_identifier 是堆栈 ARN,如示例命令中所示。

    $ aws resource-groups create-group \ --name group_name \ --description "description" \ --resource-query '{"Type":"CLOUDFORMATION_STACK_1_0","Query":"{\"StackIdentifier\":\"stack_identifier\",\"ResourceTypeFilters\":[\"resource_type1\",\"resource_type2\"]}"}'

    以下命令是一个示例。

    $ aws resource-groups create-group \ --name My-CFN-stack-group \ --description "My first CloudFormation stack-based group" \ --resource-query '{"Type":"CLOUDFORMATION_STACK_1_0","Query":"{\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack\/AWStestuseraccount\/fb0d5000-aba8-00e8-aa9e-50d5cEXAMPLE\",\"ResourceTypeFilters\":[\"AWS::EC2::Instance\",\"AWS::S3::Bucket\"]}"}'
  2. 在对命令的响应中返回以下内容。

    • 您创建的组的完整描述。

    • 您用于创建组的资源查询。