aws/aws-cdk

awsapigatewayv2: Expose disableExecuteApiEndpoint option in WebSocketApi configuration

Open

#35,516 opened on Sep 17, 2025

View on GitHub
 (3 comments) (0 reactions) (0 assignees)TypeScript (10,710 stars) (3,530 forks)batch import
@aws-cdk/aws-apigatewayv2effort/mediumfeature-requestgood first issuep2

Description

Describe the feature

The CfnApi construct has a disableExecuteApiEndpoint option: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.CfnApi.html#disableexecuteapiendpoint

The WebSocketApi does not expose this option and does not expose the underlying CfnApi resource for further configuration. This makes it impossible to disable the default endpoint.

WebSocketApi docs: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketApi.html

Relevant WebSocketApi code: https://github.com/aws/aws-cdk/blob/v2.214.0/packages/aws-cdk-lib/aws-apigatewayv2/lib/websocket/api.ts#L158

Use Case

For security reasons, I would like to remove the default endpoint in my WebSocketApi.

Proposed Solution

Please expose this option for use with WebSocketApi constructs.

Other Information

No response

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.191.0

AWS CDK CLI version

2.1011.0

Environment details (OS name and version, etc.)

any

Contributor guide

Tech stack
typescript
Domain
cloudinfrastructure
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.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic AWS CDK knowledgeTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Examine the existing CfnApi construct's disableExecuteApiEndpoint implementation (see docs link). Then review the WebSocketApi construct code at packages/aws cdk lib/aws apigatewayv2/lib/websocket/api.ts, particularly around line 158. Follow the pattern used for similar options in WebSocketApi (e.g., how it wraps CfnWebSocketApi). Add a new property to the WebSocketApiProps interface and pass it through to the underlying CfnWebSocketApi resource. No linked PRs or assignee indicates it's available for new contributors.