API Gateway (REST)
Managed REST / WebSocket API endpoint.
Configuration
Section titled “Configuration”| Setting | Type | Required | Default |
|---|---|---|---|
| API name | Text | Yes | — |
| Description | Text | — | — |
| Endpoint type Options: Regional, Edge, Private | Choice | — | REGIONAL |
| API key source Options: Header (x-api-key), Authorizer context | Choice | — | HEADER |
| Binary media types | List | — | — |
| Min compression size (bytes) | Number | — | -1 |
| Resource policy (JSON) | Text | — | — |
| Disable default execute-api endpoint | Toggle | — | false |
| Stage name | Text | — | prod |
| Cache cluster enabled | Toggle | — | false |
| Cache size (GB) Options: 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237 | Choice | — | — |
| X-Ray tracing | Toggle | — | false |
| Detailed CloudWatch metrics | Toggle | — | false |
| Logging level Options: Off, Error, Info | Choice | — | OFF |
| Throttling burst | Number | — | — |
| Throttling rate (rps) | Number | — | — |
| Tags | Key–value | — | — |
Connections
Section titled “Connections”| Socket | Direction | Accepts | Terraform arg |
|---|---|---|---|
| Client | Input | any | — |
| Cognito authorizer | Input | aws.cognito-user-pool | — |
| Integration | Output | any | — |