编辑账户中扩展的配置数据 - AWS CloudFormation

编辑账户中扩展的配置数据

本主题提供有关编辑特定区域内账户中扩展配置数据的指导。扩展可包含应用于给定账户和区域所有扩展实例的配置属性。扩展作者会在扩展的配置定义中定义这些属性。如果扩展的配置定义中有任何必需的属性,则必须先指定这些属性,然后才能在您的账户和区域中使用扩展。

有关在开发扩展时如何定义配置定义的更多信息,请参阅以下文档。

使用动态引用所需的权限

如果配置数据包含对存储在 AWS Systems Manager 或 AWS Secrets Manager 中的值的动态引用,则用于预置类型的任何角色(例如,在创建或更新堆栈时)必须具有检索该值的适当权限。具体来说:

  • 如果配置数据包含存储在 AWS Systems Manager Parameter Store 中的参数,则用于预置该类型的用户或角色必须有权调用 GetParameter

  • 如果配置数据包含存储在 AWS Secrets Manager 中的密钥,则用于预置该类型的用户或角色必须有权调用 GetSecretValue

有关更多信息,请参阅 使用动态引用获取存储在其他服务中的值

编辑扩展的配置数据(控制台)

请按照本部分中的步骤,使用控制台来执行以下操作:

  • 查看扩展的当前配置数据

  • 更新账户的扩展配置数据

查看扩展的当前配置数据
  1. 登录到 AWS Management Console 并打开 AWS CloudFormation 控制台 https://console.aws.amazon.com/cloudformation

  2. 在屏幕顶部的导航栏中,选择您的 AWS 区域。

  3. 找到您要查看的扩展。有关更多信息,请参阅 查看 CloudFormation 注册表中可用和已激活的扩展

  4. 选择扩展以查看扩展详细信息。

  5. 在扩展详细信息页面上,选择 Configuration(配置)选项卡。

  6. 展开 Configuration schema(配置架构)选项卡以查看为扩展定义的配置架构。

  7. 展开 Configuration(配置)选项卡以查看为此扩展设置的当前配置。

更新扩展的配置数据
  1. 在扩展详细信息页面上,从配置选项卡中选择编辑配置

    或者,从操作中选择编辑,然后选择编辑配置

    CloudFormation 将显示 Configure extension(配置扩展)页面。确保打开 View configuration schema(查看配置架构)以查看扩展的当前配置定义架构。

  2. Configuration JSON(配置 JSON)文本框中,输入一个 JSON 字符串,该字符串表示要为此扩展设置的配置架构。它必须根据 Configuration schema(配置架构)中定义的架构进行验证。

  3. 选择配置扩展程序

编辑扩展的配置数据(AWS CLI)

请按照本部分中的步骤,使用 AWS CLI 来执行以下操作:

  • 查看扩展的当前配置数据

  • 更新账户的扩展配置数据

查看扩展的当前配置数据
  • 使用 describe-type 命令返回有关扩展的详细信息。输出的 ConfigurationSchema 元素包含给定区域中扩展的当前配置定义。

    或者,使用 batch-describe-type-configurations 命令返回有关多个扩展的配置数据。

更新扩展的配置数据
  • 使用 set-type-configuration 命令指定配置数据。为 --configuration 传递的 JSON 必须根据扩展的配置架构进行验证。

    在以下示例中,set-type-configuration 命令指定了 --configuration 选项的配置数据 "{"CredentialKey": "testUserCredential"}"

    aws cloudformation set-type-configuration --type RESOURCE \ --type-name My::Resource::Example \ --configuration-alias default \ --configuration "{"CredentialKey": "testUserCredential"}" \ --region us-west-2