アカウントでサードパーティーのプライベートモジュールまたはリソースタイプを登録して有効化する
このトピックでは、共有されているサードパーティーのプライベートモジュールまたはリソースタイプを登録し、コマンドラインを使用して AWS CloudFormation レジストリを介して有効にする手順について説明します。拡張が有効化されると、それが登録されているアカウントとリージョンのすべての CloudFormation テンプレートで使用できるようになります。
注記
続行する前に、プライベート拡張を登録するために必要な IAM アクセス許可 があることを確認してください。
共有されているプライベートモジュールまたはリソースタイプを登録するには (AWS CLI)
-
アカウントに登録するプライベートモジュールまたはリソースタイプを含む Amazon S3 バケットを見つけます。
-
register-type コマンドを使用して、プライベートリソースタイプをアカウントに登録します。
例えば、次のコマンドは、指定した AWS アカウント に
My::Resource::Example
リソースタイプを登録します。aws cloudformation register-type --type
RESOURCE
\ --type-nameMy::Resource::Example
\ --schema-handler-package[s3 object path]
--regionus-west-2
RegisterType
は非同期オペレーションであり、登録リクエストの進行状況を追跡するために使用できる登録トークンを返します。{ "RegistrationToken": "f5525280-104e-4d35-bef5-8f1fexample" }
拡張がその機能の一部として AWS API を呼び出す場合は、これらの AWS API を呼び出すために必要なアクセス許可を含む IAM 実行ロールを作成し、アカウントにその実行ロールをプロビジョニングする必要があります。その後、
--execution-role-arn
オプションを使用してこの実行ロールを指定できます。CloudFormation は、その実行ロールを引き受け、リソースタイプに適切な認証情報を提供します。--execution-role-arn
arn:aws:iam::111122223333:role/MyIAMRole
-
(オプション) 登録トークンを describe-type-registration コマンドとともに使用して、登録リクエストの進行状況を追跡します。
CloudFormation が登録リクエストを完了すると、リクエストの進捗ステータスが
COMPLETE
に設定されます。次の例では、上記の
describe-type-registration
コマンドによって返された登録トークンを使用して、登録ステータス情報を返します。aws cloudformation describe-type-registration \ --registration-token
f5525280-104e-4d35-bef5-8f1fexample
\ --regionus-west-2
このコマンドは、以下の出力を返します。
{ "ProgressStatus": "COMPLETE", "TypeArn": "arn:aws:cloudformation:us-east-1:012345678910:type/resource/My-Resource-Example", "Description": "Deployment is currently in DEPLOY_STAGE of status COMPLETED; ", "TypeVersionArn": "arn:aws:cloudformation:us-east-1:111122223333:type/resource/My-Resource-Example/00000001" }