@liflig/cdk
    Preparing search index...

    Type Alias CognitoUserPoolOrBasicAuthAuthorizerProps<AuthScopesT>

    type CognitoUserPoolOrBasicAuthAuthorizerProps<
        AuthScopesT extends string = string,
    > = {
        basicAuthCredentialsSecretName?: string;
        requiredScope?: AuthScopesT;
        userPool: IUserPool;
    }

    Type Parameters

    • AuthScopesT extends string = string
    Index

    Properties

    basicAuthCredentialsSecretName? requiredScope? userPool

    Properties

    basicAuthCredentialsSecretName?: string

    Name of secret in AWS Secrets Manager that stores basic auth credentials.

    See BasicAuthAuthorizerProps.credentialsSecretName for the supported formats.

    requiredScope?: AuthScopesT

    Verifies that access token claims contain the given scope. Only applicable for requests that use Authorization: Bearer <access token> (not applicable for basic auth).

    When defined as part of a resource server, scopes are on the format: {resource server identifier}/{scope name}, e.g. external/view_users.

    To get more type safety on this parameter, see the docs for the AuthScopesT type parameter on ApiGateway.

    userPool: IUserPool

    Settings

    Member Visibility

    On This Page

    Properties