aws/aws-cdk

apigateway: add binaryMediaTypes property to SpecRestApi construct

Open

#35,498 opened on Sep 15, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (3,530 forks)batch import
@aws-cdk/aws-apigatewayeffort/mediumfeature-requestgood first issuep2

Repository metrics

Stars
 (10,710 stars)
PR merge metrics
 (Avg merge 13d 14h) (134 merged PRs in 30d)

Description

Describe the feature

The SpecRestApi construct should accept as one of his construct props a binaryMediaTypes property that is the list of binary media mime-types that are supported by the resource.

This is already supported by the RestApi construct and by the underlying CloudFormation resource:

Use Case

When the API Gateway have to return binary data the mime-type has to be added in the API Gateway settings via the BinaryMediaTypes property.

Proposed Solution

Add the binaryMediaTypes to the SpecRestApi construct

Other Information

At the moment the alternative solution is to use escape hatches: https://docs.aws.amazon.com/cdk/v2/guide/cfn-layer.html

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

AWS CDK Library version (aws-cdk-lib)

2.213.0

AWS CDK CLI version

2.174.1

Environment details (OS name and version, etc.)

Linux

Contributor guide

Research direction
Examine the existing RestApi construct's binaryMediaTypes property implementation in the AWS CDK library, then replicate it for SpecRestApi following the same pattern and referencing the CloudFormation resource documentation.
Tech stack
typescript
Domain
infrastructurecloud
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptAWS CDKAWS API Gateway
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70