在您的帳戶中註冊第三方私有延伸模組 - AWS CloudFormation

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

在您的帳戶中註冊第三方私有延伸模組

本主題涵蓋註冊與您共用的第三方私有延伸模組的步驟，以便可在您的帳戶中使用。

注意

在繼續之前，請確認您有註冊私有延伸IAM 許可模組所需的 。

註冊與您共用的私有延伸模組 (AWS CLI)

  1. 找到 Amazon S3 儲存貯體，其中包含您要在帳戶中註冊之私有延伸項目的專案套件。

  2. 使用 register-type 命令來在您的帳戶中註冊私有延伸模組。

    例如，下列命令會在指定的 中註冊My::Resource::Example資源類型 AWS 帳戶。

    aws cloudformation register-type --type RESOURCE \
  --type-name My::Resource::Example \
  --schema-handler-package [s3 object path] --region us-west-2

    RegisterType 是一種非同步操作，會傳回您可以用來追蹤註冊請求進度的註冊權杖。

    {
    "RegistrationToken": "f5525280-104e-4d35-bef5-8f1fexample"
}

    如果您的延伸模組呼叫 AWS APIs 做為其功能的一部分，您必須建立包含呼叫這些角色必要許可的IAM執行角色 AWS APIs，並在您的帳戶中佈建該執行角色。然後，您可以使用 --execution-role-arn選項指定此執行角色。 CloudFormation 然後， 會擔任該執行角色，為您的資源類型提供適當的登入資料。

    --execution-role-arn arn:aws:iam::123456789012:role/MyIAMRole

  3. （選用） 搭配 使用註冊字符 describe-type-registration 命令來追蹤您的註冊請求進度。

    當 CloudFormation 完成註冊請求時，它會將請求的進度狀態設定為 COMPLETE。

    以下範例會使用以上 describe-type-registration 命令傳回的註冊權杖來傳回註冊狀態資訊。

    aws cloudformation describe-type-registration \
  --registration-token f5525280-104e-4d35-bef5-8f1fexample \
  --region us-west-2

    命令會傳回下列輸出：

    {
    "ProgressStatus": "COMPLETE",
    "TypeArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Resource-Example",
    "Description": "Deployment is currently in DEPLOY_STAGE of status COMPLETED; ",
    "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/My-Resource-Example/00000001"
}
重要

如果您要註冊的延伸模組是勾點，則下一個步驟是必要的。您必須為 HookInvocationStatus 屬性指定 ENABLED。此操作會啟用勾點結構描述properties區段中定義的勾點屬性。如需詳細資訊，請參閱《Hooks 使用者指南》中的勾點組態結構描述語法參考。 AWS CloudFormation

指定勾點的組態資料 (AWS CLI)

  1. 取得ARN適用於您的勾點的 並儲存它。您可以使用 AWS Management Console 或 取得勾點ARN的 AWS CLI。如需詳細資訊，請參閱 在 CloudFormation 登錄檔中檢視可用的和已啟用的延伸模組。

    export HOOK_TYPE_ARN="arn:aws:cloudformation:us-west-2:123456789012:type/hook/Organization-Service-Hook/"

  2. 使用 set-type-configuration 命令來指定組態資料。JSON 您傳遞給 的 --configuration 必須驗證 Hook 的組態結構描述。若要啟用勾點，您必須在 ENABLED HookConfiguration區段中將 HookInvocationStatus 屬性設定為 。

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

    如需詳細資訊，請參閱《Hooks 使用者指南》中的勾點組態結構描述語法參考。 AWS CloudFormation