Api Gateway cache key parameters - method level vs integration level?


Hi, in api gateway with caching enabled, what's the difference to flag "caching" checkbox for a query string parameter at method request level versus integration request request level?

Method request level Method request level

Integration request level Integration request level

In addition, in a proxy type gateway, do we have to flag "caching" checkbox for the default "proxy" path parameter in order to have it included in the caching key?

Enter image description here

1 Answer

As mentioned in the document https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html, "When a cached method or integration has parameters, which can take the form of custom headers, URL paths, or query strings, you can use some or all of the parameters to form cache keys. API Gateway can cache the method's responses, depending on the parameter values used." So where you define the cache key will determine at what point will the incoming request be evaluated against the cached keys.

If you have defined a proxy resource only and no other resource in the API, then the settings on the proxy resource will apply on all resources. If there are more specific resources defined, then the settings on those specific resources will apply to those specific resources and the proxy settings will apply to every other resource. To understand how proxy resources work, please take a look at https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html under this section "Use a proxy resource to streamline API setup".

profile picture
answered 2 months ago
  • Hi Indranil, thank you. But in both the first 2 screenshots I'm inside the "proxy resource" and at GET method definition, I'm not configuring other resources or other methods, so I still have doubts ;) About the necessity to mark as cacheable the proxy path parameter, do you have any hint?

You are not logged in. Log in to post an answer.

A good answer clearly answers the question and provides constructive feedback and encourages professional growth in the question asker.

Guidelines for Answering Questions