# Method

Extends: Construct › Resource › Method
Implements: IResource, IEnvironmentAware, IConstruct, IDependable

- CloudFormation: [`AWS::ApiGateway::Method`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-method.html)
- L1 type: [`CfnMethod`](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.CfnMethod.html)
- Source: [`aws-apigateway/lib/method.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-apigateway/lib/method.ts#L173)
- Type last changed: v2.224.0 · 13 Nov 2025

## Example

```ts
declare const integration: apigateway.LambdaIntegration;

const api = new apigateway.RestApi(this, 'hello-api');

const v1 = api.root.addResource('v1');
const echo = v1.addResource('echo');
const echoMethod = echo.addMethod('GET', integration, { apiKeyRequired: true });

const plan = api.addUsagePlan('UsagePlan', {
  name: 'Easy',
  throttle: {
    rateLimit: 10,
    burstLimit: 2
  }
});

const key = api.addApiKey('ApiKey');
plan.addApiKey(key);
```

## Initializer

```ts
new Method(scope: Construct, id: string, props: MethodProps)
```

## Construct Props

- `httpMethod`: string (required) — The HTTP method ("GET", "POST", "PUT", ...) that clients use to call this method.

- `integration`: [Integration](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Integration.html) — The backend system that the method calls when it receives a request.

  **Default:** a new `MockIntegration`.

- `options`: [MethodOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.MethodOptions.html) — Method options.

  **Default:** No options.

- `resource`: [IResource](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IResource.html) (required) — The resource this method is associated with.

  For root resource methods,
  specify the `RestApi` object.

## Properties

- `api`: [IRestApi](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IRestApi.html) — The API Gateway RestApi associated with this method.

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

- `httpMethod`: string

- `methodArn`: string — Returns an execute-api ARN for this method:.

  arn:aws:execute-api:{region}:{account}:{restApiId}/{stage}/{method}/{path}

  NOTE: {stage} will refer to the `restApi.deploymentStage`, which will
  automatically set if auto-deploy is enabled, or can be explicitly assigned.
  When not configured, {stage} will be set to '*', as a shorthand for 'all stages'.

- `methodId`: string

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

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `resource`: [IResource](/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IResource.html)

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

- `testMethodArn`: string — Returns an execute-api ARN for this method's "test-invoke-stage" stage.

  This stage is used by the AWS Console UI when testing the method.

## Methods

- `addMethodResponse(methodResponse: MethodResponse): void` — Add a method response to this method.

  You should only add one method reponse for every status code. The API allows it
  for historical reasons, but will add a warning if this happens. If you do, your Method
  will nondeterministically use one of the responses, and ignore the rest.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

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

- `grantExecute(grantee: IGrantable): Grant` — Grants an IAM principal permission to invoke this method.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — the principal.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, stage: IStageRef, props?: MetricOptions): Metric` — Returns the given named metric for this API method.

- `metricCacheHitCount(stage: IStageRef, props?: MetricOptions): Metric` — Metric for the number of requests served from the API cache in a given period.

- `metricCacheMissCount(stage: IStageRef, props?: MetricOptions): Metric` — Metric for the number of requests served from the backend in a given period, when API caching is enabled.

- `metricClientError(stage: IStageRef, props?: MetricOptions): Metric` — Metric for the number of client-side errors captured in a given period.

- `metricCount(stage: IStageRef, props?: MetricOptions): Metric` — Metric for the total number API requests in a given period.

- `metricIntegrationLatency(stage: IStageRef, props?: MetricOptions): Metric` — Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.

- `metricLatency(stage: IStageRef, props?: MetricOptions): Metric` — The time between when API Gateway receives a request from a client and when it returns a response to the client.

  The latency includes the integration latency and other API Gateway overhead.

- `metricServerError(stage: IStageRef, props?: MetricOptions): Metric` — Metric for the number of server-side errors captured in a given period.

- `toString(): string` — Returns a string representation of this construct.

- `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.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.