software.amazon.awscdk

Enum RemovalPolicy

java.lang.Object

java.lang.Enum<RemovalPolicy>

software.amazon.awscdk.RemovalPolicy

All Implemented Interfaces:

Serializable, Comparable<RemovalPolicy>

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.663Z")
 @Stability(value=Experimental)
public enum RemovalPolicy
extends Enum<RemovalPolicy>

(experimental) Possible values for a resource's Removal Policy.

The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

• The resource is removed from the template, so CloudFormation stops managing it;
• A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it;
• The stack is deleted, so CloudFormation stops managing all resources in it.

The Removal Policy applies to all above cases.

Many stateful resources in the AWS Construct Library will accept a removalPolicy as a property, typically defaulting it to RETAIN.

If the AWS Construct Library resource does not accept a removalPolicy argument, you can always configure it by using the escape hatch mechanism, as shown in the following example:

 // Example automatically generated from non-compiling source. May contain errors.
 Bucket bucket;
 CfnResource cfnBucket = (CfnResource)bucket.node.findChild("Resource");
 cfnBucket.applyRemovalPolicy(RemovalPolicy.DESTROY);
 

Example:

 Function fn = Function.Builder.create(this, "MyFunction")
         .currentVersionOptions(VersionOptions.builder()
                 .removalPolicy(RemovalPolicy.RETAIN) // retain old versions
                 .retryAttempts(1)
                 .build())
         .runtime(Runtime.NODEJS_12_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .build();
 fn.currentVersion.addAlias("live");
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESTROY (experimental) This is the default removal policy.
RETAIN (experimental) This uses the 'Retain' DeletionPolicy, which will cause the resource to be retained in the account, but orphaned from the stack.
SNAPSHOT (experimental) This retention policy deletes the resource, but saves a snapshot of its data before deleting, so that it can be re-created later.

Method Summary

Modifier and Type	Method and Description
static RemovalPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static RemovalPolicy[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DESTROY

@Stability(value=Experimental)
public static final RemovalPolicy DESTROY

(experimental) This is the default removal policy.

It means that when the resource is removed from the app, it will be physically destroyed.

RETAIN

@Stability(value=Experimental)
public static final RemovalPolicy RETAIN

(experimental) This uses the 'Retain' DeletionPolicy, which will cause the resource to be retained in the account, but orphaned from the stack.

SNAPSHOT

@Stability(value=Experimental)
public static final RemovalPolicy SNAPSHOT

(experimental) This retention policy deletes the resource, but saves a snapshot of its data before deleting, so that it can be re-created later.

Only available for some stateful resources, like databases, EFS volumes, etc.

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Method Detail

values

public static RemovalPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RemovalPolicy c : RemovalPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RemovalPolicy 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