aws / aws/aws-cdk

apigwv2: AuthorizerPayloadFormatVersion not a field in HttpLambdaAuthorizerProps

Open
#21,492 5 comments 6 reactions 0 assignees View on GitHub
@aws-cdk/aws-iam effort/small feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the feature

The HttpLambdaAuthorizerProps includes a response type field, however, you can't choose the IAM response type and set the version of the payload format as 2.0.
The IAM payload 2.0 behaves a bit differently than 1.0, as described here:
https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.html#http-api-lambda-authorizer.payload-format-response
It would be great to be able to set this as a prop in HttpLambdaAuthorizerProps.

### Use Case

APIGW deployment using CDK would be much smoother with this.

### Proposed Solution

_No response_

### Other Information

_No response_

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### CDK version used

2.35.0

### Environment details (OS name and version, etc.)

Ubuntu 20.04

Contributor guide

Open the contributing guide

Research direction

Start at HttpLambdaAuthorizerProps and the apigwv2 HTTP Lambda authorizer implementation. Compare the existing response-type handling with the linked AWS payload-format documentation, then inspect nearby tests. Done means the prop can select the IAM response mode and payload format 2.0, with coverage for the resulting configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
api, cloud
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.