sst/dist/aws/realtime.d.ts

import { IoTCustomAuthorizerHandler, PolicyDocument } from "aws-lambda";
/**
 * The `realtime` client SDK is available through the following.
 *
 * @example
 * ```js title="src/authorizer.ts"
 * import { realtime } from "sst/aws/realtime";
 * ```
 */
export declare namespace realtime {
    interface AuthResult {
        /**
         * The principal ID of the authorized client. This could be a user ID, username, or
         * phone number.
         *
         * The value must be an alphanumeric string with at least one, and no more than 128,
         * characters and match the regex pattern, `([a-zA-Z0-9]){1,128}`.
         */
        principalId?: string;
        /**
         * The maximum duration in seconds of the connection to IoT Core.
         *
         * :::note
         * This is set when the connection is established and cannot be modified during subsequent
         * policy refresh authorization handler invocations.
         * :::
         *
         * The minimum value is 300 seconds, and the maximum is 86400 seconds.
         * @default `86400`
         */
        disconnectAfterInSeconds?: number;
        /**
         * The duration in seconds between policy refreshes. After the given duration, IoT Core
         * will invoke the authorization handler function.
         *
         * The minimum value is 300 seconds, and the maximum value is 86400 seconds.
         */
        refreshAfterInSeconds?: number;
        /**
         * The topics the client can subscribe to.
         * @example
         * For example, this subscribes to two specific topics.
         * ```js
         * {
         *   subscribe: ["chat/room1", "chat/room2"]
         * }
         * ```
         *
         * And to subscribe to all topics under a given prefix.
         * ```js
         * {
         *   subscribe: ["chat/*"]
         * }
         * ```
         */
        subscribe?: string[];
        /**
         * The topics the client can publish to.
         * @example
         * For example, this publishes to two specific topics.
         * ```js
         * {
         *   publish: ["chat/room1", "chat/room2"]
         * }
         * ```
         * And to publish to all topics under a given prefix.
         * ```js
         * {
         *   publish: ["chat/*"]
         * }
         * ```
         */
        publish?: string[];
        /**
         * Any additional [IoT Core policy documents](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) to attach to the client.
         *
         * There's a maximum of 10 policy documents. Where each document can contain a maximum of
         * 2048 characters.
         * @example
         * ```js
         * {
         *   policyDocuments: [
         *     {
         *       Version: "2012-10-17",
         *       Statement: [
         *         {
         *           Action: "iot:Publish",
         *           Effect: "Allow",
         *           Resource: "*"
         *         }
         *       ]
         *     }
         *   ]
         * }
         * ```
         */
        policyDocuments?: PolicyDocument[];
    }
    /**
     * Creates an authorization handler for the `Realtime` component. It validates
     * the token and grants permissions for the topics the client can subscribe and publish to.
     *
     * @example
     * ```js title="src/authorizer.ts" "realtime.authorizer"
     * export const handler = realtime.authorizer(async (token) => {
     *   // Validate the token
     *   console.log(token);
     *
     *   // Return the topics to subscribe and publish
     *   return {
     *     subscribe: ["*"],
     *     publish: ["*"],
     *   };
     * });
     * ```
     */
    function authorizer(input: (token: string) => Promise<AuthResult>): IoTCustomAuthorizerHandler;
}