Authorizers

The generated WebSocketApi construct allows you to define an authorizer for securing your WebSocket API. The provided authorizer is applied to the $connect route to allow or deny connections. Authorizers from the AWS APIGatewayv2 Authorizers CDK module are used to define this.

Pass your chosen authorizer to the construct as the authorizer, or omit this if you would not like to manage access to your API.

For example, you can configure IAM auth as follows:

TSJAVAPYTHON

new WebSocketApi(this, "Api", {
  authorizer: new WebSocketIamAuthorizer(),
  integrations: MockIntegrations.mockAll(),
});

Warning

Java is not yet supported.

Warning

Python is not yet supported.

---

Last update: 2024-11-17