Interface CognitoUserPoolConfig

interface CognitoUserPoolConfig {
    groups?: Record<string, UserGroupPrecedence>[];
    loginWith?: {
        email?: boolean;
        oauth?: OAuthConfig;
        phone?: boolean;
        username?: boolean;
    };
    mfa?: {
        smsEnabled?: boolean;
        status?: CognitoUserPoolConfigMfaStatus;
        totpEnabled?: boolean;
    };
    passwordFormat?: {
        minLength?: number;
        requireLowercase?: boolean;
        requireNumbers?: boolean;
        requireSpecialCharacters?: boolean;
        requireUppercase?: boolean;
    };
    passwordless?: {
        emailOtpEnabled?: boolean;
        preferredChallenge?: PreferredChallenge;
        smsOtpEnabled?: boolean;
        webAuthn?: {
            relyingPartyId?: string;
            userVerification?: string;
        };
    };
    signUpVerificationMethod?: "link" | "code";
    userAttributes?: Partial<Record<AuthStandardAttributeKey, {
        required: boolean;
    }>>;
    userPoolClientId: string;
    userPoolEndpoint?: string;
    userPoolId: string;
}

Properties

groups? loginWith? mfa? passwordFormat? passwordless? signUpVerificationMethod? userAttributes? userPoolClientId userPoolEndpoint? userPoolId

Properties

Optional groups

groups?: Record<string, UserGroupPrecedence>[]

Optional loginWith

loginWith?: {
    email?: boolean;
    oauth?: OAuthConfig;
    phone?: boolean;
    username?: boolean;
}

Type declaration

  • Optional email?: boolean
  • Optional oauth?: OAuthConfig
  • Optional phone?: boolean
  • Optional username?: boolean

Optional mfa

mfa?: {
    smsEnabled?: boolean;
    status?: CognitoUserPoolConfigMfaStatus;
    totpEnabled?: boolean;
}

Type declaration

Optional passwordFormat

passwordFormat?: {
    minLength?: number;
    requireLowercase?: boolean;
    requireNumbers?: boolean;
    requireSpecialCharacters?: boolean;
    requireUppercase?: boolean;
}

Type declaration

  • Optional minLength?: number
  • Optional requireLowercase?: boolean
  • Optional requireNumbers?: boolean
  • Optional requireSpecialCharacters?: boolean
  • Optional requireUppercase?: boolean

Optional passwordless

passwordless?: {
    emailOtpEnabled?: boolean;
    preferredChallenge?: PreferredChallenge;
    smsOtpEnabled?: boolean;
    webAuthn?: {
        relyingPartyId?: string;
        userVerification?: string;
    };
}

Type declaration

  • Optional emailOtpEnabled?: boolean
  • Optional preferredChallenge?: PreferredChallenge
  • Optional smsOtpEnabled?: boolean
  • Optional webAuthn?: {
        relyingPartyId?: string;
        userVerification?: string;
    }
    • Optional relyingPartyId?: string
    • Optional userVerification?: string

Optional signUpVerificationMethod

signUpVerificationMethod?: "link" | "code"

Optional userAttributes

userAttributes?: Partial<Record<AuthStandardAttributeKey, {
    required: boolean;
}>>

userPoolClientId

userPoolClientId: string

Optional userPoolEndpoint

userPoolEndpoint?: string

Use this field to specify a custom endpoint for the Amazon Cognito user pool. Ensure this endpoint is correct and valid.

userPoolId

userPoolId: string

Settings

Member Visibility

Theme

On This Page