aws/aws-cdk

awsapigatewayv2: Expose disableExecuteApiEndpoint option in WebSocketApi configuration

オープン

#35,516 opened on 2025/09/17

 (4 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (3,530 件のフォーク)batch import
@aws-cdk/aws-apigatewayv2effort/mediumfeature-requestgood first issuemixinsp2

Repository metrics

Stars
 (10,710 個のスター)
PR merge metrics
 (平均マージ 14d 11h) (30d で 68 merged PRs)

説明

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

コントリビューターガイド