# IResource

Extends: IResource
Extends: IResource, IResourceRef
Implemented by: ProxyResource, Resource, ResourceBase

- Source: [`aws-apigateway/lib/resource.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigateway/lib/resource.ts#L18)
- Type last changed: v2.224.0 · 13 Nov 2025

## Properties

- `api`: [IRestApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IRestApi.html) — The rest API that this resource is part of.

  The reason we need the RestApi object itself and not just the ID is because the model
  is being tracked by the top-level RestApi object for the purpose of calculating its
  hash to determine the ID of the deployment. This allows us to automatically update
  the deployment when the model of the REST API changes.

- `defaultCorsPreflightOptions`: [CorsOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CorsOptions.html) — Default options for CORS preflight OPTIONS method.

- `defaultIntegration`: [Integration](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Integration.html) — An integration to use as a default for all methods created within this API unless an integration is specified.

- `defaultMethodOptions`: [MethodOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.MethodOptions.html) — Method options to use as a default for all methods created within this API unless custom options are specified.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `parentResource`: [IResource](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IResource.html) — The parent of this resource or undefined for the root resource.

- `path`: string — The full path of this resource.

- `resourceId`: string — The ID of the resource.

- `resourceRef`: [ResourceReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_apigateway.ResourceReference.html) — A reference to a Resource resource.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

## Methods

- `addCorsPreflight(options: CorsOptions): Method` — Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.

  Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional
  HTTP headers to tell browsers to give a web application running at one
  origin, access to selected resources from a different origin. A web
  application executes a cross-origin HTTP request when it requests a
  resource that has a different origin (domain, protocol, or port) from its
  own.

  **Parameters**

  - `options` — CORS options.

  **Returns:** a `Method` object

- `addMethod(httpMethod: string, target?: Integration, options?: MethodOptions): Method` — Defines a new method for this resource.

  **Parameters**

  - `httpMethod` — The HTTP method.
  - `target` — The target backend integration for this method.
  - `options` — Method options, such as authentication.

  **Returns:** The newly created `Method` object.

- `addProxy(options?: ProxyResourceOptions): ProxyResource` — Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.

  **Parameters**

  - `options` — Default integration and method options.

- `addResource(pathPart: string, options?: ResourceOptions): Resource` — Defines a new child resource where this resource is the parent.

  **Parameters**

  - `pathPart` — The path part for the child resource.
  - `options` — Resource options.

  **Returns:** A Resource object

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  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`).

- `getResource(pathPart: string): IResource // chainable` — Retrieves a child resource by path part.

  **Parameters**

  - `pathPart` — The path part of the child resource.

  **Returns:** the child resource or undefined if not found

- `resourceForPath(path: string): Resource` — Gets or create all resources leading up to the specified path.

  - Path may only start with "/" if this method is called on the root resource.
  - All resources are created using default options.

  **Parameters**

  - `path` — The relative path.

  **Returns:** a new or existing resource.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining