激活账户中的第三方公有扩展 - Amazon CloudFormation
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

激活账户中的第三方公有扩展

以下主题向您展示如何在您的账户中激活第三方公有扩展,从而使其在激活该扩展的账户和区域中可用。

注意

在继续操作之前,请确认您已创建将与此扩展一起使用的 IAM 角色

激活公有扩展(控制台)

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

  • 激活第三方公有扩展

  • 为您的账户指定其他扩展配置数据

激活公有扩展以在您的账户中使用
  1. 登录到 Amazon Web Services Management Console 并打开 Amazon CloudFormation 控制台 https://console.aws.amazon.com/cloudformation

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

  3. 从导航窗格的 CloudFormation 注册表下,选择公共扩展程序

  4. 使用筛选条件选择扩展类型,然后选择第三方。(Amazon 发布的扩展默认已激活。)

  5. 选择扩展,然后选择激活

    如果有多个版本的扩展可用,则您可以使用版本菜单选择要激活的扩展版本。默认为最新版本。

  6. 使用扩展类型别名激活扩展:

    1. 选择覆盖默认值

    2. 输入要用于此扩展的扩展类型别名。别名必须遵循扩展类型的推荐格式。

    有关更多信息,请参阅 使用别名以引用扩展

  7. 如果要启用私有资源,您可以指定 CloudFormation 在调用扩展时要承担的 IAM 角色。

  8. 如果需要,在 Logging config(日志记录配置)下指定扩展的日志记录配置信息。例如:

    { "logRoleArn": "arn:aws:iam::account:role/rolename", "logGroupName": "log-group-name" }

    日志记录配置信息并非必需,但建议用于调试目的。要使用带有挂钩的日志记录配置,请添加与指定的执行角色相同的信任策略,以便日志角色可以将日志写入日志组。

    logRoleArnlogGroupName 键名区分大小写。

  9. 版本控制自动更新下,选择如何接收更新。

    • On(开)- 自动更新为最新次要版本。主要版本手动更新。

    • Off(关)- 永不自动更新为最新版本。所有版本均手动更新。

    有关更多信息,请参阅 自动使用新版本的扩展

如果扩展需要其他配置,则您可以选择现在指定配置数据,也可以在扩展激活后指定该数据。

重要

如果您要激活的扩展是挂钩,则必须执行此步骤。您必须为 HookInvocationStatus 属性指定 ENABLED。此操作启用挂钩架构 properties 部分中定义的挂钩属性。有关更多信息,请参阅《Amazon CloudFormation Hooks User Guide》中的 Hooks configuration schema syntax reference

指定配置数据
  1. 对于配置,选择立即配置,然后选择激活扩展

    CloudFormation 将显示 Configure extension(配置扩展)页面。要查看扩展的当前配置架构,请确保 View configuration schema(查看配置架构)已激活。

  2. 配置 JSON 文本框中,输入一个 JSON 字符串,该字符串表示要为此扩展指定的配置数据。您指定的 JSON 必须根据扩展的配置架构进行验证。

  3. 选择配置扩展程序

如果您希望在激活后配置扩展,则可以跳过此步骤并稍后提供配置数据。

  1. 对于配置,选择稍后配置,然后选择激活扩展

  2. 激活扩展后,您可以通过从已激活的扩展页面导航到该扩展并提供配置数据以对其进行配置。

激活公有扩展(Amazon CLI)

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

  • 激活第三方公有扩展

  • 为您的账户指定其他扩展配置数据

激活公有挂钩

在您的账户中激活挂钩,即授权挂钩使用您的 Amazon Web Services 账户中定义的权限。CloudFormation 会删除不需要的权限,然后再将您的权限传递给挂钩。CloudFormation 建议,客户或挂钩用户在您的账户中激活挂钩之前,先查看挂钩权限并了解允许挂钩使用的权限。

激活公有挂钩以在您的账户中使用(Amazon CLI)
  1. 获取并保存挂钩的 ARN。您可以使用 Amazon Web Services Management Console 或 Amazon CLI 获取挂钩的 ARN。有关更多信息,请参阅查看 CloudFormation 注册表中可用和已激活的扩展

    export HOOK_TYPE_ARN="arn:aws:cloudformation:us-west-2:123456789012:type/hook/Organization-Service-Hook/"
  2. 使用 set-type-configuration 命令指定配置数据。为 --configuration 传递的 JSON 必须根据挂钩的配置架构进行验证。要激活所有堆栈操作的挂钩,必须在 HookConfiguration 部分中将 HookInvocationStatus 属性设置为 ENABLED

    aws cloudformation set-type-configuration \ --configuration "{"CloudFormationConfiguration":{"HookConfiguration":{"HookInvocationStatus": "ENABLED", "FailureMode": "FAIL", "Properties":{}}}}" \ --type-arn $HOOK_TYPE_ARN --region us-west-2

    有关 HookConfiguration 配置选项的更多信息,请参阅《Amazon CloudFormation Hooks User Guide》中的 Hook configuration schema syntax reference

激活公有模块和资源类型

激活公有扩展以在您的账户中使用(Amazon CLI)
  • 使用 activate-type 激活扩展,并指定在发布扩展的新次要版本时是否自动更新扩展。

    下面的示例指定要为此账户激活的公有扩展的公共 Amazon 资源名称(ARN)。此外,它指定 CloudFormation 在每次发布新的次要版本时更新扩展。

    aws cloudformation activate-type \ --public-type-arn public_extension_ARN \ --auto-update true --region us-west-2

    此命令返回已激活扩展的 ARN。

    { "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Resource-Example" }

更新公有扩展的版本(Amazon CLI)

使用 activate-type 再次激活该扩展。

使用 --version-bump 选项可指定是否将扩展更新为最新 MAJOR 版本或最新 MINOR 版本。

aws cloudformation activate-type --type RESOURCE \ --type-name Example::Test::1234567890abcdef0 \ --type-name-alias Example::Test::Alias \ --version-bump MAJOR --region us-west-2