在帳戶中啟用第三方公有延伸模組 - AWS CloudFormation

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

在帳戶中啟用第三方公有延伸模組

下列主題說明如何在帳戶中啟用第三方公有延伸模組,這使得它可在其啟用的帳戶和區域中使用。

注意

在繼續之前,請確認您已建立要與此延伸模組搭配使用IAM 角色的 。

啟用公有延伸模組 (主控台)

請依照本節中的步驟,使用主控台執行下列操作:

  • 啟用第三方公有延伸模組

  • 為您的帳戶指定其他延伸組態資料

啟用公有擴充功能以用於您的帳戶
  1. 登入 AWS Management Console 並在 https://console.aws.amazon.com/cloudformation 開啟 AWS CloudFormation 主控台。

  2. 在畫面頂端的導覽列上,選擇您的 AWS 區域。

  3. 從導覽窗格的CloudFormation登錄檔 下,選擇公有延伸模組

  4. 使用篩選條件選擇延伸類型,然後選擇第三方 。( AWS 發佈的擴充功能預設為已啟用。)

  5. 選擇延伸模組,然後選擇啟用

    如果有多個版本的擴充功能可用,您可以使用版本選單來選擇要啟用的擴充功能版本。預設為最新版本。

  6. 若要使用擴充功能類型別名啟用擴充功能:

    1. 選擇覆寫預設值

    2. 輸入要搭配此擴充功能使用的擴充功能類型別名。別名必須遵循擴充功能類型的推薦格式。

    如需詳細資訊,請參閱使用別名來參考延伸模組

  7. 如果您要啟用私有資源,您可以指定 IAM角色 CloudFormation ,以便在叫用延伸模組時擔任。

  8. Logging config (記錄設定) 下,指定擴充功能的記錄組態資訊 (若需要)。例如:

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

    記錄組態資訊不是必需的,但建議作為除錯用途使用。若要搭配 Hooks 使用記錄組態,請新增與指定執行角色相同的信任政策,讓日誌角色可以將日誌寫入您的日誌群組。

    logRoleArnlogGroupName金鑰名稱區分大小寫。

  9. 版本控制 下,自動更新 ,選擇如何接收更新。

    • On (打開) – 自動更新為最新次要版本。主要版本需手動更新。

    • Off (關閉) – 永不自動更新為最新版本。所有版本需手動更新。

    如需詳細資訊,請參閱自動使用新版本的延伸模組

如果延伸模組需要額外組態,您可以選擇立即或在啟用延伸模組之後指定組態資料。

重要

如果您要啟動的延伸模組是 Hook,則此步驟為必要步驟。您必須為 TargetStack 屬性指定 ALL。此操作會啟用 Hook 結構描述properties區段中定義的 Hook 屬性。如需詳細資訊,請參閱 Hooks 使用者指南中的 Hooks 組態結構描述AWS CloudFormation

指定組態資料
  1. 針對組態 ,選擇立即設定 ,然後選擇啟用延伸模組

    CloudFormation 會顯示設定擴充功能頁面。若要檢視擴充功能的目前組態結構描述,請確保已啟用 View configuration schema (檢視組態結構描述)。

  2. 組態JSON文字方塊中,輸入代表您要為此延伸模組指定組態資料的JSON字串。JSON 您指定的 必須驗證延伸模組的組態結構描述。

  3. 選擇設定延伸模組

如果您想要在啟用後設定延伸模組,您可以略過此步驟,並在稍後提供組態資料。

  1. 針對組態 ,選擇稍後設定 ,然後選擇啟用延伸模組

  2. 啟用擴充功能後,您可以從啟用的擴充功能頁面導覽至擴充功能並提供組態資料,以進行設定。

啟用公有延伸模組 (AWS CLI)

請依照本節中的步驟使用 AWS CLI 來:

  • 啟用第三方公有延伸模組

  • 為您的帳戶指定其他延伸組態資料

啟用公有掛鉤

透過在帳戶中啟用 Hooks,您即授權 Hook 使用 中定義的許可 AWS 帳戶。在將許可傳遞給 Hook 之前 CloudFormation , 會移除不需要的許可。 CloudFormation 建議客戶或 Hook 使用者檢閱 Hook 許可,並了解在帳戶中啟用 Hooks 之前允許 Hooks 使用哪些許可。

啟用公有掛鉤以用於您的帳戶 (AWS CLI)
  1. 取得 Hook ARN的 並儲存。您可以使用 AWS Management Console 或 取得 掛鉤ARN的 AWS CLI。如需詳細資訊,請參閱 在 CloudFormation 登錄檔中檢視可用的和已啟用的延伸模組

    export HOOK_TYPE_ARN="arn:aws:cloudformation:us-east-1:123456789012:type/hook/Organization-Service-Hook/"
  2. 使用 set-type-configuration 命令來指定組態資料。JSON 您傳遞的 必須--configuration驗證 Hook 的組態結構描述。若要為所有堆疊操作啟用掛鉤,您必須在 ALL HookConfiguration區段中將 TargetStacks 屬性設定為 。

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

    如需HookConfiguration組態選項的詳細資訊,請參閱 Hooks 使用者指南中的 Hook 組態結構描述AWS CloudFormation

啟用公有模組和資源類型

啟用公有擴充功能以用於您的帳戶 (AWS CLI)
  • 使用 activate-type 啟用擴充功能,並指定是否在發佈擴充功能的新次要版本時自動更新擴充功能。

    以下範例指定要為此帳戶啟用的公有延伸的公有 Amazon Resource Name (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-east-1:123456789012:type/resource/My-Resource-Example" }

更新公有延伸模組 (AWS 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