software.amazon.awscdk.core

Enum RemovalPolicy

java.lang.Object

java.lang.Enum<RemovalPolicy>

software.amazon.awscdk.core.RemovalPolicy

All Implemented Interfaces:

Serializable, Comparable<RemovalPolicy>

@Generated(value="jsii-pacmak/1.13.0 (build 385c325)",
           date="2020-10-23T23:56:39.143Z")
 @Stability(value=Stable)
public enum RemovalPolicy
extends Enum<RemovalPolicy>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DESTROY This is the default removal policy.
RETAIN This uses the 'Retain' DeletionPolicy, which will cause the resource to be retained in the account, but orphaned from the stack.
SNAPSHOT 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=Stable)
public static final RemovalPolicy DESTROY

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=Stable)
public static final RemovalPolicy RETAIN

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

SNAPSHOT

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

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