ApiGatewayWebSocketRoute
Reference doc for the `sst.aws.ApiGatewayWebSocketRoute` component.
The ApiGatewayWebSocketRoute
component is internally used by the ApiGatewayWebSocket
component to add routes to your API Gateway WebSocket API.
You’ll find this component returned by the route
method of the ApiGatewayWebSocket
component.
Constructor
Parameters
-
name
string
-
args
Args
-
opts?
ComponentResourceOptions
Properties
nodes
Type Object
The underlying resources this component creates.
nodes.integration
Type Integration
The API Gateway HTTP API integration.
nodes.permission
Type Permission
The Lambda permission.
nodes.route
Type Route
The API Gateway HTTP API route.
nodes.function
Type Output
<
Function
>
The Lambda function.
Args
api
Type Input
<
Object
>
The API Gateway to use for the service.
api.executionArn
Type Input
<
string
>
The execution ARN of the API Gateway.
api.id
Type Input
<
string
>
The ID of the API Gateway.
api.name
Type Input
<
string
>
The name of the API Gateway.
auth?
Type Input
<
Object
>
Enable auth for your WebSocket API.
auth.iam?
Type Input
<
boolean
>
Default false
Enable IAM authorization for a given API route. When IAM auth is enabled, clients need to use Signature Version 4 to sign their requests with their AWS credentials.
handler
Type Input
<
string
|
FunctionArgs
>
The function that’ll be invoked.
route
Type Input
<
string
>
The path for the route.
transform?
Type Object
Transform how this component creates its underlying resources.
transform.integration?
Type IntegrationArgs
|
(
args
:
IntegrationArgs
,
opts
:
ComponentResourceOptions
,
name
:
string
)
=>
void
Transform the API Gateway WebSocket API integration resource.
transform.route?
Type RouteArgs
|
(
args
:
RouteArgs
,
opts
:
ComponentResourceOptions
,
name
:
string
)
=>
void
Transform the API Gateway WebSocket API route resource.