リソースオペレーションの実行 - Cloud Control API
前提条件認証情報の指定リクエストが一意であることの確認考慮事項

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

リソースオペレーションの実行

AWS Cloud Control API を使用して、AWS アカウント 内のリソースに対してその他のコマンド動詞構築作成、読み取り、更新、削除、およびリスト (-L) オペレーションを行います。

コンテンツ

Cloud Control API でリソースを使用するための前提条件

Cloud Control API を使用して特定のリソースをプロビジョニングするには、そのリソースタイプが Cloud Control API をサポートしていて、AWS アカウント で使用できる必要があります。

  • AWS アカウント で使用できるリソース

    アカウントで使用できるようにするには、パブリックリソースタイプをアクティブ化し、プライベートリソースタイプを登録する必要があります。サポートされている AWS リソースタイプはパブリックで、常にアクティブ化されてます。詳細については、「リソースタイプの使用」を参照してください。

  • Cloud Control API をサポートするリソース

    Cloud Control API をサポートしている AWS リソースタイプの一覧については、「Cloud Control API をサポートするリソースタイプ」を参照してください。

    サードパーティリソースタイプは、パブリックもプライベートも Cloud Control API をサポートしています。

    特定のリソースタイプが Cloud Control API をサポートしているかどうかを確認する方法の詳細については、「リソースタイプが Cloud Control API をサポートしているかどうかの判断」を参照してください。

リソースタイプの使用方法の詳細については、「リソースタイプの使用」を参照してください。

Cloud Control API の認証情報の指定

Cloud Control API は、ユーザーに代わり AWS リソースに対してオペレーションを実行する一環として、それらのリソースを実際にプロビジョニングする基盤となる AWS サービスを呼び出す必要があります。そのために、Cloud Control API は、それらのサービスにアクセスする際に求められる認証情報を必要とします。Cloud Control API でこれらの認証情報を取得できるようにするには、次の 2 つの方法があります。

  • ユーザー認証情報

    デフォルトでは、Cloud Control API は AWS ユーザー認証情報を使用して一時セッションを作成し、そのセッションを使用してダウンストリーム AWS サービスへの必要な呼び出しを行います。このセッションは最大 24 時間続き、その後、Cloud Control API AWS による残りの呼び出しはすべて失敗します。

  • サービスロール認証情報

    リソースリクエストを行う際に、リソースオペレーション中に引き受けるサービスロールを Cloud Control API に対して指定することもできます。その他の利点としては、サービスロールを指定することで、Cloud Control API は基盤となる AWS サービスを最大 36 時間呼び出せるようになるという点が挙げられます。

    サービスロールを使用するには、リソースオペレーションリクエストの RoleArn パラメータを指定します。

    Cloud Control API アクションはAWS CloudFormationサービスの一部であるため、指定するサービスロールは CloudFormation サービス () によって引き受けられますcloudformation.amazonaws.com。詳細については、「AWS CloudFormation ユーザーガイド」の「AWS CloudFormation サービスロール」を参照してください。

各リソースハンドラーに必要な権限は、そのリソースタイプのスキーマの handlers セクションで定義されます。リソーススキーマの表示の詳細については、「リソースタイプのスキーマの表示」を参照してください。handlers セクションはリソースタイプ定義スキーマで定義されます。

Cloud Control API を使用する際、リソースオペレーションリクエストが一意であることを確認する

ベストプラクティスとして、作成、削除、および更新リソースオペレーションリクエストでは冪等性トークンを指定することを強くお勧めします。できれば、普遍一意識別子 (UUID) など、リクエストごとに一意のトークンを指定してください。このようなトークンがあれば、リクエストを再試行しなければならない場合でもリクエストのあいまいさを解消できます。

create-resource、delete-resource、update-resource の各オペレーションにはすべて client-token パラメータがあり、このパラメータは冪等性トークンに設定できます。

Cloud Control API を使用するときの考慮事項

Cloud Control API を使用してリソースオペレーションを実行する場合は、以下のサービス動作を考慮することをお勧めします。

  • Cloud Control API は、各リソースオペレーションを個別に、他のリソースオペレーションとは独立して実行します。

  • Cloud Control API への単一のリソースオペレーションリクエストは、実際には、リソースをプロビジョニングする基盤となるサービスへの複数の呼び出しで構成されている場合があります。このため、リソースリクエストは、部分的にしか完了していない場合は失敗となり、リクエストされた変更の一部だけがリソースに適用されてしまうことがあります。

  • リソースオペレーションがいずれかの時点で失敗しても、Cloud Control API はリソースを以前の状態にロールバックしません。

  • Cloud Control API を使用すると、特定のリソースに対して一度に 1 つのリソースオペレーションしか実行できません。ただし、リソースは、そのリソースをプロビジョニングした基盤となるサービスを通じて直接操作することはできます。予測できない動作を引き起こす可能性があるため、この方法は使用しないことを強くお勧めします。