@resistdesign/voltra
    Preparing search index...

    Type Alias AddAuthConfigBase

    Configuration for the auth pack.

    type AddAuthConfigBase = {
        adminGroupId: string;
        apiCloudFunctionGatewayId: string;
        apiStageName: string;
        authRoleName: string;
        unauthRoleName: string;
        userManagementAdminGroupName: string;
        userManagementId: string;
        userManagementIds?: UserManagementIds;
    }
    Index

    Properties

    adminGroupId apiCloudFunctionGatewayId apiStageName authRoleName unauthRoleName userManagementAdminGroupName userManagementId userManagementIds?

    Properties

    adminGroupId: string

    Resource id for the admin group.

    apiCloudFunctionGatewayId: string

    API Gateway REST API id for authenticated access.

    apiStageName: string

    API Gateway stage name for authenticated access.

    authRoleName: string

    IAM role name for authenticated users.

    unauthRoleName: string

    IAM role name for unauthenticated users.

    userManagementAdminGroupName: string

    Cognito group name for admins.

    userManagementId: string

    Base id for Cognito resources.

    userManagementIds?: UserManagementIds

    Optional explicit logical ids for generated user-management resources.

    userManagementIds: {
      userPool: "MyUserPool",
      userPoolClient: "MyUserPoolClient",
    }

    Settings

    Member Visibility

    On This Page

    Properties