配置 Amazon Q 开发者版 CloudZero 插件 - Amazon Q 开发者版

配置 Amazon Q 开发者版 CloudZero 插件

CloudZero 是一款云成本优化平台,可通过成本评估提升云资源使用效率。如果您使用 CloudZero 监控 AWS 成本,可在 Amazon Q 开发者版聊天工具中使用 CloudZero 插件,无需离开 AWS Management Console即可获取成本洞察信息。

借助 CloudZero 插件,您可以了解 AWS 成本、获取成本优化洞察信息并跟踪账单。收到响应后,您还可以提出后续问题,例如 CloudZero 洞察信息的状态或成本影响。

要配置插件,您需提供 CloudZero 账户中的身份验证凭证,以建立 Amazon Q 与 CloudZero 之间的连接。配置插件后,通过在 Amazon Q 聊天中将 @cloudzero 添加到问题的开头,即可访问 CloudZero 数据。

警告

Amazon Q 中的 CloudZero 插件无法检测 CloudZero 的用户权限。当管理员在某个 AWS 账户中配置 CloudZero 插件后,该账户中拥有插件权限的用户即可访问插件能检索到的 CloudZero 账户中的所有资源。

您可以配置 IAM 策略来限制用户可访问的插件。有关更多信息,请参阅配置用户权限

先决条件

添加权限

要配置插件,需具备以下管理员级别的权限:

获取凭证

开始配置前,请记录您 CloudZero 账户中的以下信息。配置插件时,这些身份验证凭证将存储在 AWS Secrets Manager 密钥中。

  • API 密钥:一种访问密钥,允许 Amazon Q 调用 CloudZero API 以访问您组织的成本洞察信息和账单信息。您可在 CloudZero 账户设置中找到该 API 密钥。有关更多信息,请参阅 CloudZero 文档中的授权

有关从 CloudZero 账户获取凭证的更多信息,请参阅 CloudZero 文档

密钥与服务角色

AWS Secrets Manager 密钥

配置插件时,Amazon Q 会为您创建一个新的 AWS Secrets Manager 密钥,用于存储 CloudZero 身份验证凭证。此外,您也可以使用自己创建的现有密钥。

如果您选择自己创建密钥,请以明文形式输入 API 密钥:

your-api-key

有关创建密钥的更多信息,请参阅《AWS Secrets Manager 用户指南》中的创建密钥

服务角色

要在 Amazon Q 开发者版中配置 CloudZero 插件,您需要创建一个服务角色,用于授予 Amazon Q 访问 Secrets Manager 密钥的权限。Amazon Q 会通过扮演该角色来访问存储 CloudZero 凭证的密钥。

在 AWS 控制台中配置插件时,您可以选择创建新密钥,也可以使用现有密钥。若创建新密钥,系统会自动为您创建关联的服务角色。若使用现有密钥和现有服务角色,请确保您的服务角色包含以下权限,并已附加相应的信任策略。所需的服务角色取决于您的密钥加密方式。

如果密钥使用 AWS 托管 KMS 密钥进行加密,需使用以下 IAM 服务角色:

如果密钥使用客户托管 AWS KMS 密钥进行加密,需使用以下 IAM 服务角色:

要允许 Amazon Q 扮演该服务角色,服务角色需包含以下信任策略:

注意

codewhisperer 前缀是与 Amazon Q 开发者版合并前的服务的旧名称。有关更多信息,请参阅Amazon Q 开发者版重命名:变更摘要

JSON
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "q.amazonaws.com" }, "Action": ["sts:AssumeRole", "sts:SetContext"], "Condition": { "StringEquals": { "aws:SourceAccount": "{{accountId}}", "aws:SourceArn": "arn:aws:codewhisperer:{{region}}:{{accountId}}:profile/{{profileId}}" } } } ] }

有关服务角色的更多信息,请参阅《AWS Identity and Access Management 用户指南》中的创建向 AWS 服务委派权限的角色

配置 CloudZero 插件

您需在 Amazon Q 开发者版控制台中配置插件。Amazon Q 会使用存储在 AWS Secrets Manager 中的凭证,实现与 CloudZero 的交互。

要配置 CloudZero 插件,请完成以下流程:

  1. 打开 Amazon Q 开发者版控制台(网址为 https://console.aws.amazon.com/amazonq/developer/home)。

  2. 在 Amazon Q 开发者版控制台首页,选择设置

  3. 在导航栏中,选择插件

  4. 在插件页面,点击 CloudZero 面板上的加号,打开插件配置页面。

  5. 配置 AWS Secrets Manager中,选择创建新密钥使用现有密钥。Secrets Manager 密钥将用于存储您的 CloudZero 身份验证凭证。

    如果您要创建新密钥,请输入以下信息:

    1. CloudZero API 密钥字段中,输入您 CloudZero 组织的 API 密钥。

    2. 系统会自动创建一个服务角色,供 Amazon Q 访问存储 CloudZero 凭证的密钥。请勿编辑系统为您创建的服务角色。

    如果您使用现有密钥,请从 AWS Secrets Manager 密钥下拉菜单中选择一个密钥。该密钥需包含前文步骤中指定的 CloudZero 身份验证凭证。

    有关所需凭证的更多信息,请参阅获取凭证

  6. 配置 AWS IAM 服务角色部分,选择创建新服务角色使用现有服务角色

    注意

    如果您在步骤 6 中选择了创建新密钥,则无法使用现有服务角色。系统会自动为您创建一个新角色。

    如果您要创建新的服务角色,系统会自动创建一个服务角色,供 Amazon Q 访问存储 CloudZero 凭证的密钥。请勿编辑系统为您创建的服务角色。

    如果您要使用现有服务角色,请从显示的下拉菜单中选择一个角色。请确保该服务角色包含服务角色中定义的权限和信任策略。

  7. 选择保存配置

  8. 当 CloudZero 插件面板显示在“插件”页面的已配置插件部分后,用户即可访问该插件。

如果您要更新插件凭证,必须删除当前插件,然后配置一个新插件。删除插件会清除之前的所有配置信息,且每次配置新插件时,都会生成一个新的插件 ARN。

配置用户权限

要使用插件,需具备以下权限:

  • 在控制台中与 Amazon Q 进行交互的权限。有关授予聊天所需权限的 IAM 策略示例,请参阅允许用户与 Amazon Q 聊天

  • q:UsePlugin 权限。

当您向某个 IAM 身份授予已配置 CloudZero 插件的访问权限后,该身份将能访问插件可检索的 CloudZero 账户中的所有资源。该插件无法检测 CloudZero 的用户权限。若需控制对插件的访问权限,可在 IAM 策略中指定插件的 ARN。

每次创建插件或删除并重新配置插件时,系统都会为其分配一个新的 ARN。如果您在策略中使用了插件 ARN,且希望授予对新配置插件的访问权限,则需更新该 ARN。

要查找 CloudZero 插件的 ARN,请转至 Amazon Q 开发者版控制台的插件页面,然后选择已配置的 CloudZero 插件。在“插件详细信息”页面,复制插件 ARN。您可将该 ARN 添加到策略中,以允许或拒绝对 CloudZero 插件的访问。

如果您创建策略以控制对 CloudZero 插件的访问权限,请在策略中指定插件提供商为 CloudZero

有关控制插件访问权限的 IAM 策略示例,请参阅支持用户与来自一个提供商的插件进行聊天

与 CloudZero 插件进行交互

要使用 CloudZero 插件,需在关于 CloudZero 或 AWS 应用程序监控和案例的问题开头输入 @cloudzero。针对 Amazon Q 问题的后续提问或回复,也必须包含 @cloudzero

以下是一些使用案例示例及对应的问题,可帮助您充分利用 Amazon Q CloudZero 插件:

  • 了解 CloudZero 如何与 AWS 搭配使用:咨询 CloudZero 功能的使用方法。Amazon Q 可能会询问您更多关于您所尝试操作的信息,以提供最佳答案。

    • @cloudzero how do I use CloudZero?

    • @cloudzero how do I get started with CloudZero?

  • 列出成本洞察信息:获取成本洞察信息列表,或了解特定洞察的更多信息。

    • @cloudzero list my top cost insights

    • @cloudzero tell me more about insight <insight ID>

  • 获取账单信息:向 Amazon Q CloudZero 插件咨询 AWS 账单信息。

    • @cloudzero what were my AWS costs for December 2024?