パッチドキュメントの作成 Cloud Control API がリソースを更新する方法リソース更新リクエストの進行状況の追跡

を使用したリソースの更新 AWS Cloud Control API

update-resource コマンドを使用して、既存のリソースを更新します。これには、Cloud Control API を使用してもともとプロビジョニングされていなかったリソースも含まれます。

重要

Cloud Control API を使用して、他のサービスによってアクティブに管理されているリソースを更新しないことを強くお勧めします。これを行うと、予期しない結果につながる可能性があります。例えば、Cloud Control API を使用して、現在 AWS CloudFormation スタックの一部であるリソースを更新しないでください。

既存のリソースを更新するには、リソースの識別子を指定する必要があります。リソースの識別子の決定方法の詳細については、「リソースのプライマリ識別子の使用」を参照してください。

リソースを更新すると、リソースプロパティの値が変更されます。リソースのプロパティはリソースタイプスキーマで定義されます。これには、そのプロパティが必須かどうか、有効な値、プロパティのその他の制約が含まれます。リソースプロパティ定義の表示の詳細については、「リソースタイプのスキーマの表示」を参照してください。

パッチドキュメントの作成

リソースを更新するには、まず JSON パッチドキュメントに含まれるパッチオペレーションのリストとして更新を定義します。このパッチドキュメントは、「RFC 6902 - JavaScript Object Notation (JSON) Patch」で定義されている標準に準拠している必要があります。

各パッチオペレーションでは、特定のリソースプロパティの 1 回の更新が定義されます。以下は必須プロパティです。

op: オペレーションのタイプ。Cloud Control API は、RFC 6902 で定義されているすべてのオペレーション (add、remove、replace、move、copy、test) をサポートします。
path: リソーススキーマの properties セクションを基準とした、リソースプロパティへのパス。

オペレーションによっては、追加のプロパティが必要になる場合があります。詳細については、「RFC 6902」を参照してください。

update-resource コマンドを使用するときは、パッチドキュメントを文字列としてインラインで指定することも、ファイルの場所を指定することもできます。

次のの例では、という名前の AWS::Logs::LogGroupリソースの保持ポリシーCloudControlApiLogGroupを 90 日に更新します。


$ aws cloudcontrol update-resource --type-name AWS::Logs::LogGroup \
    --identifier CloudControlApiLogGroup \
    --patch-document '[{"op":"replace","path":"RetentionInDays","value":90}]'

Cloud Control API がリソースを更新する方法

Cloud Control API は、リソースを更新するために、まずリソースの現在の状態を取得し、次に 2 ステッププロセスでリソースを更新します。

Cloud Control API は、更新リクエストで指定されたパッチオペレーションとリソースの現在の状態を組み合わせて、更新後のリソースの目的の状態を生成します。オペレーションは、パッチドキュメントに表示されている順序でシーケンシャルに適用されます。シーケンス内の各オペレーションは、リソースの現在の状態に適用され、結果のリソースの状態が次のオペレーションの対象になります。

この時点で、次の場合、更新リクエスト全体が失敗します。
- リクエストに含まれているパッチオペレーションが無効です。
- op タイプ test のパッチオペレーションが失敗しています。
このような場合は更新リクエスト全体が失敗し、Cloud Control API はリソースを更新しません。
その後、Cloud Control API はリソースタイプの更新ハンドラーを呼び出してリソースを更新します。

更新ハンドラーがいずれかの時点で失敗しても、Cloud Control API はリソースを以前の状態にロールバックしません。

例えば、 AWS::Logs::LogGroupリソースを更新するために定義されている次のパッチドキュメントを考えてみましょう。このドキュメントには 2 つのパッチオペレーションが含まれています。最初のオペレーションはタイプ test で、リソースの保持ポリシーが 3653 日に設定されているかどうかを確認します。そのようになっていたら、リソースはテストに合格となり、Cloud Control API は次のオペレーションに進みます。このオペレーションにより、現在の保持ポリシーの値が 180 日に置き換えられます。リソースの保持ポリシーが 3653 日以外の値に設定されている場合、最初の test オペレーションは失敗となり、Cloud Control API は 2 番目の replace オペレーションを実行しません。


[
  {
    "op": "test",
    "path": "/RetentionInDays",
    "value":3653
  },
  {
    "op": "replace",
    "path": "/RetentionInDays",
    "value":180
  }
]

リソース更新リクエストの進行状況の追跡

update-resource コマンドは、リソースオペレーションリクエストの現在のステータスを追跡するために使用できる ProgressEvent オブジェクトを返します。詳細については、「リソースオペレーションリクエストの進行状況の追跡」を参照してください。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

リソースを作成

リソースの削除