Package software.amazon.awscdk.core

Enum CfnDeletionPolicy

java.lang.Object
java.lang.Enum<CfnDeletionPolicy>
software.amazon.awscdk.core.CfnDeletionPolicy
All Implemented Interfaces:
Serializable, Comparable<CfnDeletionPolicy>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:54.837Z") @Stability(Stable) public enum CfnDeletionPolicy extends Enum<CfnDeletionPolicy>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is deleted.

You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default. Note that this capability also applies to update operations that lead to resources being removed.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DELETE
    AWS CloudFormation deletes the resource and all its content if applicable during stack deletion.
    RETAIN
    AWS CloudFormation keeps the resource without deleting the resource or its contents when its stack is deleted.
    SNAPSHOT
    For resources that support snapshots (AWS::EC2::Volume, AWS::ElastiCache::CacheCluster, AWS::ElastiCache::ReplicationGroup, AWS::RDS::DBInstance, AWS::RDS::DBCluster, and AWS::Redshift::Cluster), AWS CloudFormation creates a snapshot for the resource before deleting it.

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfnDeletionPolicy
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static CfnDeletionPolicy[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DELETE

      @Stability(Stable) public static final CfnDeletionPolicy DELETE
      AWS CloudFormation deletes the resource and all its content if applicable during stack deletion.

      You can add this deletion policy to any resource type. By default, if you don't specify a DeletionPolicy, AWS CloudFormation deletes your resources. However, be aware of the following considerations:

    • RETAIN

      @Stability(Stable) public static final CfnDeletionPolicy RETAIN
      AWS CloudFormation keeps the resource without deleting the resource or its contents when its stack is deleted.

      You can add this deletion policy to any resource type. Note that when AWS CloudFormation completes the stack deletion, the stack will be in Delete_Complete state; however, resources that are retained continue to exist and continue to incur applicable charges until you delete those resources.

    • SNAPSHOT

      @Stability(Stable) public static final CfnDeletionPolicy SNAPSHOT
      For resources that support snapshots (AWS::EC2::Volume, AWS::ElastiCache::CacheCluster, AWS::ElastiCache::ReplicationGroup, AWS::RDS::DBInstance, AWS::RDS::DBCluster, and AWS::Redshift::Cluster), AWS CloudFormation creates a snapshot for the resource before deleting it.

      Note that when AWS CloudFormation completes the stack deletion, the stack will be in the Delete_Complete state; however, the snapshots that are created with this policy continue to exist and continue to incur applicable charges until you delete those snapshots.

  • Method Details

    • values

      public static CfnDeletionPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static CfnDeletionPolicy valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null