Enumeration RemovalPolicy

Possible values for a resource's Removal Policy

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

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

The Removal Policy applies to all above cases.

Many stateful resources will accept a removalPolicy as a property, typically defaulting it to RETAIN.

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

declare const resource: network.NtvProviderResource;;

const resource = resource.node.findChild('Resource') as NtvProviderResource;
resource.applyRemovalPolicy(RemovalPolicy.DESTROY);
Copy