@sst-community/sst 4.21.1 → 5.0.0-alpha.2

package/platform/src/components/aws/apigateway-websocket.ts

@@ -0,0 +1,894 @@
+import {
+  ComponentResourceOptions,
+  Output,
+  all,
+  interpolate,
+  output,
+} from "@pulumi/pulumi";
+import {
+  Component,
+  outputId,
+  Prettify,
+  Transform,
+  transform,
+} from "../component";
+import { Link } from "../link";
+import type { Input } from "../input";
+import { FunctionArgs, FunctionArn } from "./function.js";
+import { hashStringToPrettyString, physicalName, logicalName } from "../naming";
+import { DnsValidatedCertificate } from "./dns-validated-certificate";
+import { RETENTION } from "./logging";
+import { dns as awsDns } from "./dns.js";
+import { ApiGatewayV2DomainArgs } from "./helpers/apigatewayv2-domain";
+import { ApiGatewayV2Authorizer } from "./apigatewayv2-authorizer";
+import { ApiGatewayWebSocketRoute } from "./apigateway-websocket-route";
+import { setupApiGatewayAccount } from "./helpers/apigateway-account";
+import { apigatewayv2, cloudwatch } from "@pulumi/aws";
+import { permission } from "./permission";
+import { VisibleError } from "../error";
+
+export interface ApiGatewayWebSocketArgs {
+  /**
+   * Set a custom domain for your WebSocket API.
+   *
+   * Automatically manages domains hosted on AWS Route 53, Cloudflare, and Vercel. For other
+   * providers, you'll need to pass in a `cert` that validates domain ownership and add the
+   * DNS records.
+   *
+   * :::tip
+   * Built-in support for AWS Route 53, Cloudflare, and Vercel. And manual setup for other
+   * providers.
+   * :::
+   *
+   * @example
+   *
+   * By default this assumes the domain is hosted on Route 53.
+   *
+   * ```js
+   * {
+   *   domain: "example.com"
+   * }
+   * ```
+   *
+   * For domains hosted on Cloudflare.
+   *
+   * ```js
+   * {
+   *   domain: {
+   *     name: "example.com",
+   *     dns: sst.cloudflare.dns()
+   *   }
+   * }
+   * ```
+   */
+  domain?: Input<string | Prettify<ApiGatewayV2DomainArgs>>;
+  /**
+   * Configure the [API Gateway logs](https://docs.aws.amazon.com/apigateway/latest/developerguide/view-cloudwatch-log-events-in-cloudwatch-console.html) in CloudWatch. By default, access logs are enabled and kept for 1 month.
+   * @default `{retention: "1 month"}`
+   * @example
+   * ```js
+   * {
+   *   accessLog: {
+   *     retention: "forever"
+   *   }
+   * }
+   * ```
+   */
+  accessLog?: Input<{
+    /**
+     * The duration the API Gateway logs are kept in CloudWatch.
+     * @default `1 month`
+     */
+    retention?: Input<keyof typeof RETENTION>;
+  }>;
+  /**
+   * [Transform](/docs/components#transform) how this component creates its underlying
+   * resources.
+   */
+  transform?: {
+    /**
+     * Transform the API Gateway WebSocket API resource.
+     */
+    api?: Transform<apigatewayv2.ApiArgs>;
+    /**
+     * Transform the API Gateway WebSocket API stage resource.
+     */
+    stage?: Transform<apigatewayv2.StageArgs>;
+    /**
+     * Transform the API Gateway WebSocket API domain name resource.
+     */
+    domainName?: Transform<apigatewayv2.DomainNameArgs>;
+    /**
+     * Transform the CloudWatch LogGroup resource used for access logs.
+     */
+    accessLog?: Transform<cloudwatch.LogGroupArgs>;
+    /**
+     * Transform the routes. This can be used to customize the handler function and
+     * the arguments for each route.
+     *
+     * @example
+     * ```js
+     * {
+     *   transform: {
+     *     route: {
+     *       handler: {
+     *         link: [bucket, stripeKey]
+     *       },
+     *       args: {
+     *         auth: { iam: true }
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     */
+    route?: {
+      /**
+       * Transform the handler function for the route.
+       */
+      handler?: Transform<FunctionArgs>;
+      /**
+       * Transform the arguments for the route.
+       */
+      args?: Transform<ApiGatewayWebSocketRouteArgs>;
+    };
+  };
+}
+
+export interface ApiGatewayWebSocketAuthorizerArgs {
+  /**
+   * @deprecated API Gateway only supports JWT authorizers on HTTP APIs, so this stops
+   * the deploy. Use `lambda` with a function that verifies the token instead.
+   */
+  jwt?: Input<{
+    /**
+     * Base domain of the identity provider that issues JSON Web Tokens.
+     * @example
+     * ```js
+     * {
+     *   issuer: "https://issuer.com/"
+     * }
+     * ```
+     */
+    issuer: Input<string>;
+    /**
+     * List of the intended recipients of the JWT. A valid JWT must provide an `aud` that matches at least one entry in this list.
+     */
+    audiences: Input<Input<string>[]>;
+    /**
+     * Specifies where to extract the JWT from the request.
+     * @default `"route.request.header.Authorization"`
+     */
+    identitySource?: Input<string>;
+  }>;
+  /**
+   * Create a Lambda authorizer that can be used by the `$connect` route.
+   *
+   * The function returns an IAM policy that allows or denies `execute-api:Invoke`, or
+   * throws `Unauthorized`. This is also how to check a JWT, such as a Cognito token:
+   * WebSocket APIs don't support JWT authorizers, so the function verifies the token.
+   * See [`addAuthorizer`](#addauthorizer) for an example.
+   *
+   * @example
+   * Configure Lambda auth.
+   *
+   * ```js
+   * {
+   *   lambda: {
+   *     function: "src/authorizer.index"
+   *   }
+   * }
+   * ```
+   */
+  lambda?: Input<{
+    /**
+     * The Lambda authorizer function. Takes the handler path or the function args.
+     * @example
+     * Add a simple authorizer.
+     *
+     * ```js
+     * {
+     *   function: "src/authorizer.index"
+     * }
+     * ```
+     *
+     * Customize the authorizer handler.
+     *
+     * ```js
+     * {
+     *   function: {
+     *     handler: "src/authorizer.index",
+     *     memory: "2048 MB"
+     *   }
+     * }
+     * ```
+     */
+    function: Input<string | FunctionArgs>;
+    /**
+     * @deprecated WebSocket APIs ignore this. It's only for HTTP API authorizers.
+     */
+    payload?: Input<"1.0" | "2.0">;
+    /**
+     * @deprecated WebSocket APIs ignore this. A WebSocket authorizer always returns an
+     * IAM policy.
+     */
+    response?: Input<"simple" | "iam">;
+    /**
+     * Specifies where to extract the identity from. A request without it is rejected
+     * before the authorizer runs.
+     *
+     * A browser can't set headers on a WebSocket connection, so a browser client usually
+     * sends its token in the query string.
+     * @default `["route.request.header.Authorization"]`
+     * @example
+     * ```js
+     * {
+     *   identitySources: ["route.request.querystring.token"]
+     * }
+     * ```
+     */
+    identitySources?: Input<Input<string>[]>;
+  }>;
+  /**
+   * [Transform](/docs/components#transform) how this component creates its underlying
+   * resources.
+   */
+  transform?: {
+    /**
+     * Transform the API Gateway authorizer resource.
+     */
+    authorizer?: Transform<apigatewayv2.AuthorizerArgs>;
+  };
+}
+
+export interface ApiGatewayWebSocketRouteArgs {
+  /**
+   * Enable auth for your WebSocket API. By default, auth is disabled.
+   *
+   * Auth only applies to the `$connect` route: API Gateway checks it once, when a client
+   * connects. Other routes ignore it.
+   *
+   * @example
+   * ```js
+   * {
+   *   auth: {
+   *     iam: true
+   *   }
+   * }
+   * ```
+   */
+  auth?: Input<
+    | 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.
+       */
+      iam?: Input<boolean>;
+      /**
+       * @deprecated API Gateway only supports JWT auth on HTTP APIs, so this stops the
+       * deploy on the `$connect` route. Use `lambda` with a Lambda authorizer that
+       * verifies the token instead.
+       */
+      jwt?: Input<{
+        /**
+         * Authorizer ID of the JWT authorizer.
+         */
+        authorizer: 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.
+         */
+        scopes?: Input<Input<string>[]>;
+      }>;
+      /**
+       * Enable custom Lambda authorization for a given API route. Pass in the authorizer ID.
+       *
+       * @example
+       * ```js
+       * {
+       *   auth: {
+       *     lambda: myAuthorizer.id
+       *   }
+       * }
+       * ```
+       *
+       * Where `myAuthorizer` is created by calling the `addAuthorizer` method.
+       */
+      lambda?: Input<string>;
+    }
+  >;
+  /**
+   * The name of the route.
+   *
+   * By default, SST generates a unique suffix from the route path. Setting `name` gives
+   * you a stable, human-readable name like `MyApiRouteSendMessageHandler`.
+   *
+   * Must be unique across all routes.
+   *
+   * @example
+   * ```js
+   * {
+   *   name: "SendMessage"
+   * }
+   * ```
+   */
+  name?: string;
+  /**
+   * [Transform](/docs/components#transform) how this component creates its underlying
+   * resources.
+   */
+  transform?: {
+    /**
+     * Transform the API Gateway WebSocket API integration resource.
+     */
+    integration?: Transform<apigatewayv2.IntegrationArgs>;
+    /**
+     * Transform the API Gateway WebSocket API route resource.
+     */
+    route?: Transform<apigatewayv2.RouteArgs>;
+  };
+}
+
+/**
+ * The `ApiGatewayWebSocket` component lets you add an [Amazon API Gateway WebSocket API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html)
+ * to your app.
+ *
+ * @example
+ *
+ * #### Create the API
+ *
+ * ```ts title="sst.config.ts"
+ * const api = new sst.aws.ApiGatewayWebSocket("MyApi");
+ * ```
+ *
+ * #### Add a custom domain
+ *
+ * ```js {2} title="sst.config.ts"
+ * new sst.aws.ApiGatewayWebSocket("MyApi", {
+ *   domain: "api.example.com"
+ * });
+ * ```
+ *
+ * #### Add routes
+ *
+ * ```ts title="sst.config.ts"
+ * api.route("$connect", "src/connect.handler");
+ * api.route("$disconnect", "src/disconnect.handler");
+ * api.route("$default", "src/default.handler");
+ * api.route("sendMessage", "src/sendMessage.handler");
+ * ```
+ */
+export class ApiGatewayWebSocket extends Component implements Link.Linkable {
+  private constructorName: string;
+  private constructorArgs: ApiGatewayWebSocketArgs;
+  private constructorOpts: ComponentResourceOptions;
+  private api: apigatewayv2.Api;
+  private stage: apigatewayv2.Stage;
+  private apigDomain?: Output<apigatewayv2.DomainName>;
+  private apiMapping?: Output<apigatewayv2.ApiMapping>;
+  private logGroup: cloudwatch.LogGroup;
+
+  constructor(
+    name: string,
+    args: ApiGatewayWebSocketArgs = {},
+    opts: ComponentResourceOptions = {},
+  ) {
+    super(__pulumiType, name, args, opts);
+
+    const parent = this;
+
+    const accessLog = normalizeAccessLog();
+    const domain = normalizeDomain();
+
+    const apigAccount = setupApiGatewayAccount(name, opts);
+    const api = createApi();
+    const logGroup = createLogGroup();
+    const stage = createStage();
+
+    const certificateArn = createSsl();
+    const apigDomain = createDomainName();
+    createDnsRecords();
+    const apiMapping = createDomainMapping();
+
+    this.constructorName = name;
+    this.constructorArgs = args;
+    this.constructorOpts = opts;
+    this.api = api;
+    this.stage = stage;
+    this.apigDomain = apigDomain;
+    this.apiMapping = apiMapping;
+    this.logGroup = logGroup;
+
+    this.registerOutputs({
+      _hint: this.url,
+    });
+
+    function normalizeAccessLog() {
+      return output(args.accessLog).apply((accessLog) => ({
+        ...accessLog,
+        retention: accessLog?.retention ?? "1 month",
+      }));
+    }
+
+    function normalizeDomain() {
+      if (!args.domain) return;
+
+      return output(args.domain).apply((domain) => {
+        // validate
+        if (typeof domain !== "string") {
+          if (domain.name && domain.nameId)
+            throw new VisibleError(
+              `Cannot configure both domain "name" and "nameId" for the "${name}" API.`,
+            );
+          if (!domain.name && !domain.nameId)
+            throw new VisibleError(
+              `Either domain "name" or "nameId" is required for the "${name}" API.`,
+            );
+          if (domain.dns === false && !domain.cert)
+            throw new VisibleError(
+              `Domain "cert" is required when "dns" is disabled for the "${name}" API.`,
+            );
+        }
+
+        // normalize
+        const norm = typeof domain === "string" ? { name: domain } : domain;
+        return {
+          name: norm.name,
+          nameId: norm.nameId,
+          path: norm.path,
+          dns: norm.dns === false ? undefined : norm.dns ?? awsDns(),
+          cert: norm.cert,
+        };
+      });
+    }
+
+    function createApi() {
+      return new apigatewayv2.Api(
+        ...transform(
+          args.transform?.api,
+          `${name}Api`,
+          {
+            protocolType: "WEBSOCKET",
+            routeSelectionExpression: "$request.body.action",
+          },
+          { parent },
+        ),
+      );
+    }
+
+    function createLogGroup() {
+      return new cloudwatch.LogGroup(
+        ...transform(
+          args.transform?.accessLog,
+          `${name}AccessLog`,
+          {
+            name: `/aws/vendedlogs/apis/${physicalName(64, name)}`,
+            retentionInDays: accessLog.apply(
+              (accessLog) => RETENTION[accessLog.retention],
+            ),
+          },
+          { parent, ignoreChanges: ["name"] },
+        ),
+      );
+    }
+
+    function createStage() {
+      return new apigatewayv2.Stage(
+        ...transform(
+          args.transform?.stage,
+          `${name}Stage`,
+          {
+            apiId: api.id,
+            autoDeploy: true,
+            name: "$default",
+            accessLogSettings: {
+              destinationArn: logGroup.arn,
+              format: JSON.stringify({
+                // request info
+                requestTime: `"$context.requestTime"`,
+                requestId: `"$context.requestId"`,
+                eventType: `"$context.eventType"`,
+                routeKey: `"$context.routeKey"`,
+                status: `$context.status`, // integer value, do not wrap in quotes
+                // integration info
+                integrationRequestId: `"$context.awsEndpointRequestId"`,
+                integrationStatus: `"$context.integrationStatus"`,
+                integrationLatency: `"$context.integrationLatency"`,
+                integrationServiceStatus: `"$context.integration.integrationStatus"`,
+                // caller info
+                ip: `"$context.identity.sourceIp"`,
+                userAgent: `"$context.identity.userAgent"`,
+                //cognitoIdentityId:`"$context.identity.cognitoIdentityId"`, // not supported in us-west-2 region
+                connectedAt: `"$context.connectedAt"`,
+                connectionId: `"$context.connectionId"`,
+              }),
+            },
+          },
+          { parent, dependsOn: apigAccount },
+        ),
+      );
+    }
+
+    function createSsl() {
+      if (!domain) return output(undefined);
+
+      return domain.apply((domain) => {
+        if (domain.cert) return output(domain.cert);
+        if (domain.nameId) return output(undefined);
+
+        return new DnsValidatedCertificate(
+          `${name}Ssl`,
+          {
+            domainName: domain.name!,
+            dns: domain.dns!,
+          },
+          { parent },
+        ).arn;
+      });
+    }
+
+    function createDomainName() {
+      if (!domain || !certificateArn) return;
+
+      return all([domain, certificateArn]).apply(([domain, certificateArn]) => {
+        return domain.nameId
+          ? apigatewayv2.DomainName.get(
+            `${name}DomainName`,
+            domain.nameId,
+            {},
+            { parent },
+          )
+          : new apigatewayv2.DomainName(
+            ...transform(
+              args.transform?.domainName,
+              `${name}DomainName`,
+              {
+                domainName: domain.name!,
+                domainNameConfiguration: {
+                  certificateArn: certificateArn!,
+                  endpointType: "REGIONAL",
+                  securityPolicy: "TLS_1_2",
+                },
+              },
+              { parent },
+            ),
+          );
+      });
+    }
+
+    function createDnsRecords(): void {
+      if (!domain || !apigDomain) return;
+
+      domain.apply((domain) => {
+        if (!domain.dns) return;
+        if (domain.nameId) return;
+
+        domain.dns.createAlias(
+          name,
+          {
+            name: domain.name!,
+            aliasName: apigDomain.domainNameConfiguration.targetDomainName,
+            aliasZone: apigDomain.domainNameConfiguration.hostedZoneId,
+          },
+          { parent },
+        );
+      });
+    }
+
+    function createDomainMapping() {
+      if (!domain || !apigDomain) return;
+
+      return domain.path?.apply(
+        (path) =>
+          new apigatewayv2.ApiMapping(
+            `${name}DomainMapping`,
+            {
+              apiId: api.id,
+              domainName: apigDomain.id,
+              stage: "$default",
+              apiMappingKey: path,
+            },
+            { parent },
+          ),
+      );
+    }
+  }
+
+  /**
+   * The URL of the API.
+   *
+   * If the `domain` is set, this is the URL with the custom domain.
+   * Otherwise, it's the auto-generated API Gateway URL.
+   */
+  public get url() {
+    // Note: If mapping key is set, the URL needs a trailing slash. Without the
+    //       trailing slash, the API fails with the error {"message":"Not Found"}
+    return this.apigDomain && this.apiMapping
+      ? all([this.apigDomain.domainName, this.apiMapping.apiMappingKey]).apply(
+        ([domain, key]) =>
+          key ? `wss://${domain}/${key}/` : `wss://${domain}`,
+      )
+      : interpolate`${this.api.apiEndpoint}/${this.stage.name}`;
+  }
+
+  /**
+   * The management endpoint for the API used by the API Gateway Management API client.
+   * This is useful for sending messages to connected clients.
+   *
+   * @example
+   * ```js
+   * import { Resource } from "sst";
+   * import { ApiGatewayManagementApiClient } from "@aws-sdk/client-apigatewaymanagementapi";
+   *
+   * const client = new ApiGatewayManagementApiClient({
+   *   endpoint: Resource.MyApi.managementEndpoint,
+   * });
+   * ```
+   */
+  public get managementEndpoint() {
+    // ie. https://v1lmfez2nj.execute-api.us-east-1.amazonaws.com/$default
+    return this.api.apiEndpoint.apply(
+      (endpoint) =>
+        interpolate`${endpoint.replace("wss", "https")}/${this.stage.name}`,
+    );
+  }
+
+  /**
+   * The underlying [resources](/docs/components/#nodes) this component creates.
+   */
+  public get nodes() {
+    const self = this;
+    return {
+      /**
+       * The Amazon API Gateway V2 API.
+       */
+      api: this.api,
+      /**
+       * The API Gateway HTTP API domain name.
+       */
+      get domainName() {
+        if (!self.apigDomain)
+          throw new VisibleError(
+            `"nodes.domainName" is not available when domain is not configured for the "${self.constructorName}" API.`,
+          );
+        return self.apigDomain;
+      },
+      /**
+       * The CloudWatch LogGroup for the access logs.
+       */
+      logGroup: this.logGroup,
+    };
+  }
+
+  /**
+   * Add a route to the API Gateway WebSocket API.
+   *
+   * There are three predefined routes:
+   * - `$connect`: When the client connects to the API.
+   * - `$disconnect`: When the client or the server disconnects from the API.
+   * - `$default`: The default or catch-all route.
+   *
+   * In addition, you can create custom routes. When a request comes in, the API Gateway
+   * will look for the specific route defined by the user. If no route matches, the `$default`
+   * route will be invoked.
+   *
+   * :::caution
+   * [API Gateway has strict rate limits](https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html) for creating and updating resources. Creating one Lambda function for every route can significantly slow down your deployments.
+   *
+   * Use a single Lambda and handle routing in code if you don't need specific API Gateway features.
+   * :::
+   *
+   * @param route The path for the route.
+   * @param handler The function that'll be invoked.
+   * @param args Configure the route.
+   *
+   * @example
+   * Add a simple route.
+   *
+   * ```js title="sst.config.ts"
+   * api.route("sendMessage", "src/sendMessage.handler");
+   * ```
+   *
+   * Add a predefined route.
+   *
+   * ```js title="sst.config.ts"
+   * api.route("$default", "src/default.handler");
+   * ```
+   *
+   * Enable auth on the `$connect` route, where API Gateway checks it.
+   *
+   * ```js title="sst.config.ts"
+   * api.route("$connect", "src/connect.handler", {
+   *   auth: {
+   *     iam: true
+   *   }
+   * });
+   * ```
+   *
+   * Customize the route handler.
+   *
+   * ```js title="sst.config.ts"
+   * api.route("sendMessage", {
+   *   handler: "src/sendMessage.handler",
+   *   memory: "2048 MB"
+   * });
+   * ```
+   *
+   * Or pass in the ARN of an existing Lambda function.
+   *
+   * ```js title="sst.config.ts"
+   * api.route("sendMessage", "arn:aws:lambda:us-east-1:123456789012:function:my-function");
+   * ```
+   */
+  public route(
+    route: string,
+    handler: Input<string | FunctionArgs | FunctionArn>,
+    args: ApiGatewayWebSocketRouteArgs = {},
+  ) {
+    const prefix = this.constructorName;
+    const suffix = logicalName(
+      args.name
+        ? args.name
+        : ["$connect", "$disconnect", "$default"].includes(route)
+          ? route
+          : hashStringToPrettyString(`${outputId}${route}`, 6),
+    );
+
+    const transformed = transform(
+      this.constructorArgs.transform?.route?.args,
+      `${prefix}Route${suffix}`,
+      args,
+      { provider: this.constructorOpts.provider },
+    );
+
+    return new ApiGatewayWebSocketRoute(
+      transformed[0],
+      {
+        api: {
+          name: prefix,
+          id: this.api.id,
+          executionArn: this.api.executionArn,
+        },
+        route,
+        handler,
+        handlerTransform: this.constructorArgs.transform?.route?.handler,
+        ...transformed[1],
+      },
+      transformed[2],
+    );
+  }
+
+  /**
+   * Add an authorizer to the API Gateway WebSocket API.
+   *
+   * @param name The name of the authorizer.
+   * @param args Configure the authorizer.
+   *
+   * @example
+   * Add a Lambda authorizer.
+   *
+   * ```js title="sst.config.ts"
+   * const authorizer = api.addAuthorizer("MyAuthorizer", {
+   *   lambda: {
+   *     function: "src/authorizer.handler"
+   *   }
+   * });
+   * ```
+   *
+   * Then use it on the `$connect` route, where API Gateway checks auth.
+   *
+   * ```js title="sst.config.ts"
+   * api.route("$connect", "src/connect.handler", {
+   *   auth: {
+   *     lambda: authorizer.id
+   *   }
+   * });
+   * ```
+   *
+   * API Gateway doesn't support JWT authorizers on WebSocket APIs. To accept a JWT, such
+   * as a Cognito token, have the Lambda authorizer verify it. Here a browser sends the
+   * token in the query string, since it can't set headers on a WebSocket connection.
+   *
+   * ```js title="sst.config.ts"
+   * const pool = new sst.aws.CognitoUserPool("MyUserPool");
+   * const client = pool.addClient("Web");
+   *
+   * const authorizer = api.addAuthorizer("MyAuthorizer", {
+   *   lambda: {
+   *     function: {
+   *       handler: "src/authorizer.handler",
+   *       environment: {
+   *         USER_POOL_ID: pool.id,
+   *         USER_POOL_CLIENT_ID: client.id
+   *       }
+   *     },
+   *     identitySources: ["route.request.querystring.token"]
+   *   }
+   * });
+   *
+   * api.route("$connect", "src/connect.handler", {
+   *   auth: {
+   *     lambda: authorizer.id
+   *   }
+   * });
+   * ```
+   *
+   * The authorizer verifies the token with
+   * [`aws-jwt-verify`](https://github.com/awslabs/aws-jwt-verify), and returns a policy
+   * that allows the connection. Add the package to your app first.
+   *
+   * ```bash
+   * npm install aws-jwt-verify
+   * ```
+   *
+   * ```ts title="src/authorizer.ts"
+   * import { CognitoJwtVerifier } from "aws-jwt-verify";
+   *
+   * const verifier = CognitoJwtVerifier.create({
+   *   userPoolId: process.env.USER_POOL_ID!,
+   *   clientId: process.env.USER_POOL_CLIENT_ID!,
+   *   tokenUse: "access"
+   * });
+   *
+   * export async function handler(event) {
+   *   try {
+   *     const claims = await verifier.verify(event.queryStringParameters.token);
+   *     return {
+   *       principalId: claims.sub,
+   *       policyDocument: {
+   *         Version: "2012-10-17",
+   *         Statement: [
+   *           { Action: "execute-api:Invoke", Effect: "Allow", Resource: event.methodArn }
+   *         ]
+   *       }
+   *     };
+   *   } catch {
+   *     throw new Error("Unauthorized");
+   *   }
+   * }
+   * ```
+   *
+   * The client connects with the token, as `wss://<api>/<stage>?token=<token>`. For
+   * another issuer, `aws-jwt-verify`'s `JwtVerifier` or the `jose` package can check the
+   * token against the issuer's keys.
+   */
+  public addAuthorizer(name: string, args: ApiGatewayWebSocketAuthorizerArgs) {
+    const self = this;
+    const constructorName = this.constructorName;
+
+    return new ApiGatewayV2Authorizer(
+      `${constructorName}Authorizer${name}`,
+      {
+        api: {
+          id: self.api.id,
+          name: constructorName,
+          executionArn: this.api.executionArn,
+        },
+        type: "websocket",
+        name,
+        ...args,
+      },
+      { provider: this.constructorOpts.provider },
+    );
+  }
+
+  /** @internal */
+  public getSSTLink() {
+    return {
+      properties: {
+        url: this.url,
+        managementEndpoint: this.managementEndpoint,
+      },
+      include: [
+        permission({
+          actions: ["execute-api:ManageConnections"],
+          resources: [interpolate`${this.api.executionArn}/*/*/@connections/*`],
+        }),
+      ],
+    };
+  }
+}
+
+const __pulumiType = "sst:aws:ApiGatewayWebSocket";
+// @ts-expect-error
+ApiGatewayWebSocket.__pulumiType = __pulumiType;