によるリソースオペレーションリクエストの管理 AWS Cloud Control API

リソースオペレーションは非同期であるため、create-resource や update-resource などのリソースリクエストは、リソース作成または更新リクエストの現在の状態に関する情報が含まれる ProgressEvent オブジェクトを返します。

例えば、リソース作成リクエストは、最初に次の ProgressEvent オブジェクトを返す場合があります。

{
    "ProgressEvent": {
        "EventTime": "2021-08-09T18:17:15.219Z",
        "TypeName": "AWS::Logs::LogGroup",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "CREATE",
        "Identifier": "LogGroupResourceExample",
        "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789"
    }
}

ProgressEvent オブジェクトで返される情報には、リソースオペレーションリクエストを追跡またはキャンセルするために使用できるリクエストトークンが含まれます。

注記

リソースオペレーションリクエストは 7 日後に有効期限が切れます。

アクティブなリソースオペレーションリクエストのリスト

list-resource-requests コマンドを使用して、 AWS アカウント と のアクティブなリソースオペレーションリクエストのリストを返します AWS リージョン。リクエストタイプとステータスでリストをフィルタリングできます。

リソースオペレーションリクエストは 7 日後に有効期限が切れます。

次の例では、アクティブなリソースオペレーションリクエストが返されますが、進行中のリソース作成リクエストは除外されます。

$ aws cloudcontrol list-resource-requests --resource-request-status-filter \
    Operations=CREATE,OperationStatuses=IN_PROGRESS

各リソースオペレーションで返される情報には、リソースオペレーションリクエストを追跡またはキャンセルするために使用できるリクエストトークンが含まれます。

{
    "ResourceRequestStatusSummaries": [
        {
            "EventTime": "2021-08-09T18:17:16.591Z",
            "TypeName": "AWS::Logs::LogGroup",
            "OperationStatus": "SUCCESS",
            "Operation": "CREATE",
            "Identifier": "LogGroupResourceExample",
            "RequestToken": "5f40c577-3534-4b20-9599-0b0123456789"
        }
    ]
}

リソースオペレーションリクエストの進行状況の追跡

get-resource-request-status コマンドを使用して、リソースオペレーションリクエストの進行状況を追跡します。このコマンドは、最初のリソースオペレーションリクエスト時に生成された ProgressEvent オブジェクトに含まれるリクエストトークンを取得します。(list-resource-requests コマンドを使用して、リソースオペレーションリクエストのリクエストトークンを取得することもできます。) get-resource-request-status コマンドは、リクエストの現在の状態に関する情報を含む更新された ProgressEvent オブジェクトを返します。

次の例を参照してください。

$ aws cloudcontrol get-resource-request-status \
    --request-token 5f40c577-3534-4b20-9599-0b0123456789

リソースオペレーションリクエストのキャンセル

cancel-resource-request コマンドを使用して、現在進行中のリソースオペレーションリクエストをキャンセルします。特定のリソースでは一度に 1 つのオペレーションしか実行できないため、別のオペレーションを実行できるように、現在のリソースオペレーションをキャンセルしてリソースを利用できるようにする必要がある場合があります。

リソースリクエストをキャンセルしても、Cloud Control がすべてのリソースオペレーションを直ちにキャンセルAPIできるとは限りません。むしろ、Cloud Control APIはリソースイベントハンドラーへのさらなる呼び出しを停止します。Cloud Control への単一のリソースオペレーションリクエストは、実際には、リソースをプロビジョニングする基盤となるサービスへの複数の呼び出しで構成されるAPI場合があります。このため、リソースオペレーションリクエストをキャンセルすると、リクエストが部分的に完了したままになり、リクエストされた変更の一部だけがリソースに適用されてしまうことがあります。Cloud Control APIは、リソースを以前の状態にロールバックしません。

キャンセルできるのは、ステータスが PENDING または IN_PROGRESS のリソースオペレーションリクエストのみです。

注記

を呼び出すと Cloud Control によって実行されるオペレーションはCancelResourceRequestキャンセルされますがAPI、ダウンストリームサービスで既に開始されている非同期オペレーションは終了しません。