Skip to content

Commit

Permalink
docs(event_handler): add Terraform payload info for API Gateway HTTP …
Browse files Browse the repository at this point in the history
…API (#5351)

Updating docs with terraform information
  • Loading branch information
leandrodamascena authored Oct 9, 2024
1 parent 28f29c8 commit f87d60b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/core/event_handler/api_gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,9 @@ When using Amazon API Gateway HTTP API to front your Lambda functions, you can u
???+ note
Using HTTP API v1 payload? Use `APIGatewayRestResolver` instead. `APIGatewayHttpResolver` defaults to v2 payload.

<!-- markdownlint-disable-next-line MD013 -->
If you're using Terraform to deploy a HTTP API, note that it defaults the [payload_format_version](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/apigatewayv2_integration#payload_format_version){target="_blank" rel="nofollow"} value to 1.0 if not specified.

```python hl_lines="5 11" title="Using HTTP API resolver"
--8<-- "examples/event_handler_rest/src/getting_started_http_api_resolver.py"
```
Expand Down

0 comments on commit f87d60b

Please sign in to comment.