@liflig/cdk
    Preparing search index...

    Type Alias ApiGatewayRoute<AuthScopesT>

    type ApiGatewayRoute<AuthScopesT extends string = string> = {
        authorization?: AuthorizationProps<AuthScopesT>;
        includeSubpaths?: boolean;
        integration?: IntegrationProps;
        method?: HttpMethod;
        path: string;
    }

    Type Parameters

    • AuthScopesT extends string = string
    Index

    Properties

    authorization? includeSubpaths? integration? method? path

    Properties

    authorization?: AuthorizationProps<AuthScopesT>

    How requests on the route are authenticated. See AuthorizationProps for the available options.

    If undefined, uses the ApiGatewayProps.defaultAuthorization.

    includeSubpaths?: boolean

    By default, we only forward requests that match the route's path exactly. So for a route with path /api/users, a request to /api/users will be forwarded, but a request to /api/users/admin will not. If you want to forward requests to all sub-paths under the route's path, you can set this to true.

    false
    integration?: IntegrationProps

    The integration that the route will forward to. See IntegrationProps for the available options.

    If undefined, uses the ApiGatewayProps.defaultIntegration.

    method?: HttpMethod

    The HTTP method to expose. ANY exposes all HTTP methods on the path.

    "ANY"
    path: string

    The path of the route to expose through the API Gateway. Use "/" for the root route.

    Settings

    Member Visibility

    On This Page

    Properties