Skip to content

awsapigatewayv2: Expose disableExecuteApiEndpoint option in WebSocketApi configuration #35516

@MrHen

Description

@MrHen

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    @aws-cdk/aws-apigatewayv2Related to Amazon API Gateway v2effort/mediumMedium work item – several days of effortfeature-requestA feature should be added or improved.good first issueRelated to contributions. See CONTRIBUTING.mdp2

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions