Docs: Note on default payload_format_version when using Terraform's apigatewayv2

[rubenfonseca]

What were you searching in the docs?

When reading the docs on the API Gateway HTTP integration we find this:

Using HTTP API v1 payload? Use APIGatewayRestResolver instead. APIGatewayHttpResolver defaults to v2 payload.

However, when using Terraform's API Gateway v2 module, it defaults to payload version v1.

This can take a long time to debug.

Is this related to an existing documentation section?

https://docs.powertools.aws.dev/lambda/python/latest/core/event_handler/api_gateway/#api-gateway-http-api

How can we improve?

Add a note to the documentation that you need to explicitly tell Terraform to use the v2 payload format version.

Got a suggestion in mind?

No response

Acknowledgment

• I understand the final update might be different from my proposed suggestion, or refused.

[leandrodamascena]

I agree that we can improve our documentation to make it clearer. And I've already opened an issue in the Terraform repository to change this and maintain the same behavior when using AWS and Terraform.

hashicorp/terraform-provider-aws#37035