Interface CognitoAuthenticationProps

Hierarchy

  • CognitoAuthenticationProps

Properties

groups? sesEmailSender? triggers? userPoolName userPoolProps?

Properties

Optional Readonly groups

groups?: {
    [name: string]: string;
}

Groups to create in Cognito user pool Key: group name Value: group description

Type declaration

  • [name: string]: string

Optional Readonly sesEmailSender

sesEmailSender?: {
    email: string;
    name: string;
    region: string;
}

Configure SES mail sending

Type declaration

  • Readonly email: string

    Sender email. Needs to be already verified in SES

  • Readonly name: string

    Sender name

  • Readonly region: string

    AWS region to use for SES

Optional Readonly triggers

triggers?: {
    customMessages?: boolean;
    preTokenGeneration?: boolean;
}

Configure Cognito Lambda triggers

Type declaration

  • Optional Readonly customMessages?: boolean

    Attaches a lambda function to the custom message trigger

    Code has to reside in './src/lambda/cognito.custom-message.ts' with a method 'handler'

    Default

    false

  • Optional Readonly preTokenGeneration?: boolean

    Attaches a lambda function to the pre token generation trigger

    Code has to reside in './src/lambda/cognito.pre-token-generation.ts' with a method 'handler'

    Default

    false

Readonly userPoolName

userPoolName: string

Name for the Cognito user pool

Optional Readonly userPoolProps

userPoolProps?: UserPoolProps

Properties of the Cognito user pool

Settings

Member Visibility

Theme

Generated using TypeDoc