ApiGatewayWebSocketRoute

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

Note

This component is not intended to be created directly.

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

• integration

• permission

• route

• function

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 Output<Route>

The API Gateway HTTP API route.

nodes.function

Type Output<Function>

The Lambda function.

Args

api

Type Input<Object>

• executionArn

• id

• name

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<false | Object>

• iam?

• jwt? Input<Object>

  • authorizer

  • scopes?

• lambda?

Enable auth for your WebSocket API. By default, auth is disabled.

{
  auth: {
    iam: true
  }
}

auth.iam?

Type Input<boolean>

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.

auth.jwt?

Type Input<Object>

Enable JWT or JSON Web Token authorization for a given API route. When JWT auth is enabled, clients need to include a valid JWT in their requests.

You can configure JWT auth.

{
  auth: {
    jwt: {
      authorizer: myAuthorizer.id,
      scopes: ["read:profile", "write:profile"]
    }
  }
}

Where myAuthorizer is created by calling the addAuthorizer method.

auth.jwt.authorizer

Type Input<string>

Authorizer ID of the JWT authorizer.

auth.jwt.scopes?

Type Input<Input<string>[]>

Defines the permissions or access levels that the JWT grants. If the JWT does not have the required scope, the request is rejected. By default it does not require any scopes.

auth.lambda?

Type Input<string>

Enable custom Lambda authorization for a given API route. Pass in the authorizer ID.

{
  auth: {
    lambda: myAuthorizer.id
  }
}

Where myAuthorizer is created by calling the addAuthorizer method.

handler

Type Input<string | FunctionArgs | “arn:aws:lambda:${string}”>

The function that’ll be invoked.

route

Type Input<string>

The path for the route.

transform?

Type Object

• integration?

• route?

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.