Table of Contents

Interface IResource

Namespace
Amazon.CDK
Assembly
Amazon.CDK.dll

Interface for the Resource construct.

public interface IResource : IConstruct, IConstruct, IDependable
Inherited Members

Properties

Env

The environment this resource belongs to.

IResourceEnvironment Env { get; }

Property Value

IResourceEnvironment

Remarks

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Stack

The stack in which this resource is defined.

Stack Stack { get; }

Property Value

Stack

Methods

ApplyRemovalPolicy(RemovalPolicy)

Apply the given removal policy to this resource.

void ApplyRemovalPolicy(RemovalPolicy policy)

Parameters

policy RemovalPolicy

Remarks

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).