コンソールにサインインする
AWS CloudFormation
ユーザーガイド (API バージョン 2010-05-15)

AWS ドキュメント » AWS CloudFormation » ユーザーガイド » テンプレートリファレンス » リソース属性リファレンス » DeletionPolicy 属性

DeletionPolicy 属性

DeletionPolicy 属性を使用すると、スタックが削除された際にリソースを保持または (場合によっては) バックアップできます。制御する各リソースに対して DeletionPolicy 属性を指定します。DeletionPolicy 属性が設定されていない場合、AWS CloudFormation ではデフォルトでリソースが削除されます。

この機能は、スタックから削除されるリソースにつながるスタック更新オペレーションにも適用されるので注意してください。たとえば、スタックテンプレートからリソースを削除し、テンプレートでスタックを更新するとします。この機能は、スタック更新操作中に物理インスタンスが置き換えられるリソースには適用されません。たとえば、リソースのプロパティを編集して、スタック更新中に AWS CloudFormation がそのリソースを置き換えるようにするとします。

注記

例外: デフォルトポリシーは、AWS::RDS::DBCluster リソースの場合は Snapshot であり、DBClusterIdentifier プロパティを指定しないリソースの場合は AWS::RDS::DBInstance です。

スタックが削除された際にリソースを保持するには、そのリソースに対して Retain を指定します。どのリソースでも保持できます。たとえば、ネストされたスタック、Amazon S3 バケットや EC2 インスタンスを保持して、スタックの削除後もそれらのリソースを使用したり変更したりできます。

注記

AWS CloudFormation 外部のリソースを変更する場合は、保持ポリシーを使用してからスタックを削除します。そうしないと、リソースが AWS CloudFormation テンプレートの同期の対象から外れてスタックエラーが発生する場合があります。

スナップショットをサポートするリソース (AWS::EC2::Volume など) の場合は、Snapshot を指定できます。これにより AWS CloudFormation は、スナップショットを作成したうえで、リソースを削除するようになります。

次のスニペットでは、Amazon S3 バケットリソースの削除ポリシーが Retain に設定されています。このスタックを削除すると、AWS CloudFormation はバケットはそのまま維持して削除しません。

JSON

{
  "AWSTemplateFormatVersion" : "2010-09-09",
  "Resources" : {
    "myS3Bucket" : {
      "Type" : "AWS::S3::Bucket",
      "DeletionPolicy" : "Retain"
    }
  }
}

YAML

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  myS3Bucket:
    Type: AWS::S3::Bucket
    DeletionPolicy: Retain

DeletionPolicy のオプション

削除

AWS CloudFormation はスタックの削除時にリソースと (該当する場合) そのすべてのコンテンツを削除します。この削除ポリシーは、あらゆるリソースタイプに追加することができます。デフォルトでは、DeletionPolicy を指定しない場合、AWS CloudFormation はリソースを削除します。ただし、以下の点を考慮する必要があります。

  • AWS::RDS::DBCluster リソースの場合、デフォルトポリシーは Snapshot です。

  • AWS::RDS::DBInstance プロパティを指定しない DBClusterIdentifier リソースの場合、デフォルトポリシーは Snapshot です。

  • Amazon S3 バケットでは、削除を成功させるためにはバケットのすべてのオブジェクトを削除する必要があります。

Retain

AWS CloudFormation はスタックを削除する際、リソースやコンテンツを削除せず保持します。この削除ポリシーは、あらゆるリソースタイプに追加することができます。AWS CloudFormation がスタックの削除を完了すると、スタックの状態は Delete_Complete になりますが、保管されたリソースはその後も存在し続けます。それらのリソースを削除するまでは、対象料金が課金されます。

更新オペレーションの場合は、次の考慮事項が適用されます。

  • リソースが削除された場合、DeletionPolicy によって物理リソースは保持されますが、AWS CloudFormation のスコープからは削除されます。

  • 物理的な新しいリソースを作成して古いリソースと置き換えるようにリソースが更新された場合、古いリソースは、AWS CloudFormation のスコープからも含め、完全に削除されます。

スナップショット

スナップショットをサポートするリソースについては、AWS CloudFormation は削除前に、リソースのスナップショットを作成します。AWS CloudFormation がスタックの削除を完了すると、スタックの状態は Delete_Complete になりますが、このポリシーによって作成されたスナップショットはその後も存在し続けます。それらのスナップショットを削除するまでは、対象料金が課金されます。

スナップショットをサポートするリソースは以下のとおりです。

このページの内容: