ApiGatewayWebSocketRoute

The ApiGatewayWebSocketRoute component is internally used by the ApiGatewayWebSocket component to add routes to AWS API Gateway WebSocket API.

Caution

This component is not intended for public use.

You’ll find this component returned by the route method of the ApiGatewayWebSocket component.

---

Constructor

new ApiGatewayWebSocketRoute(name, args, opts?)

Parameters

• name string

• args Args

• opts? ComponentResourceOptions

Properties

nodes

Type Object

• function

• integration

• permission

• route

The underlying resources this component creates.

nodes.function

Type Output<Function>

The Lambda function.

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.

Args

api

Type Input<Object>

• executionArn

• id

• name

The cluster to use for the service.

api.executionArn

Type Input<string>

The execution ARN of the cluster.

api.id

Type Input<string>

The ID of the cluster.

api.name

Type Input<string>

The name of the cluster.

auth?

Type Input<Object>

• iam?

Enable auth for your WebSocket API.

Note

Currently only IAM auth is supported.

{
  auth: {
    iam: true
  }
}

auth.iam?

Type Input<true>

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>

handlerTransform?

Type FunctionArgs | (args: FunctionArgs => void)

route

Type Input<string>

transform?

Type Object

• integration?

• route?

Transform how this component creates its underlying resources.

transform.integration?

Type IntegrationArgs | (args: IntegrationArgs => void)

Transform the API Gateway WebSocket API integration resource.

transform.route?

Type RouteArgs | (args: RouteArgs => void)

Transform the API Gateway WebSocket API route resource.