TotemUserPoolConfigOptions

Props for the UserPool construct

Properties

accountRecovery?

readonly optional accountRecovery: any

How will a user be able to recover their account?

Default

AccountRecovery.PHONE_WITHOUT_MFA_AND_EMAIL

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:178

advancedSecurityMode?

readonly optional advancedSecurityMode: any

The user pool’s Advanced Security Mode

Default

- no value

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:200

autoVerify?

readonly optional autoVerify: any

Attributes which Cognito will look to verify automatically upon user sign up. EMAIL and PHONE are the only available options.

Default

If signInAlias includes email and/or phone, they will be included in autoVerifiedAttributes by default. If absent, no attributes will be auto-verified.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:120

customAttributes?

readonly optional customAttributes: object

Define a set of custom attributes that can be configured for each user in the user pool.

Index Signature

[key: string]: CustomAttributeType

Default

- No custom attributes.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:140

deletionProtection?

readonly optional deletionProtection: boolean

Indicates whether the user pool should have deletion protection enabled.

Default

false

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:190

deviceTracking?

readonly optional deviceTracking: any

Device tracking settings

Default

- see defaults on each property of DeviceTracking.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:195

enableSmsRole?

readonly optional enableSmsRole: boolean

Setting this would explicitly enable or disable SMS role creation. When left unspecified, CDK will determine based on other properties if a role is needed or not.

Default

- CDK will determine based on other properties of the user pool if an SMS role should be created or not.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:98

keepOriginal?

readonly optional keepOriginal: any

Attributes which Cognito will look to handle changes to the value of your users’ email address and phone number attributes. EMAIL and PHONE are the only available options.

Default

- Nothing is kept.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:127

mfa?

readonly optional mfa: any

Configure whether users of this user pool can or are required use MFA to sign in.

Default

Mfa.OFF

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:148

mfaMessage?

readonly optional mfaMessage: string

The SMS message template sent during MFA verification. Use ’{####}’ in the template where Cognito should insert the verification code.

Default

'Your authentication code is {####}.'

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:154

mfaSecondFactor?

readonly optional mfaSecondFactor: any

Configure the MFA types that users can use in this user pool. Ignored if mfa is set to OFF.

Default

{ sms: true, otp: false }, if mfa is set to OPTIONAL or REQUIRED. { sms: false, otp: false }, otherwise

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:161

passwordPolicy?

readonly optional passwordPolicy: PasswordPolicyConfig

Password policy for this user pool.

Default

- see defaults on each property of PasswordPolicy.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:166

removalPolicy?

readonly optional removalPolicy: any

Policy to apply when the user pool is removed from the stack

Default

RemovalPolicy.RETAIN

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:184

selfSignUpEnabled?

readonly optional selfSignUpEnabled: boolean

Whether self sign-up should be enabled. To configure self sign-up configuration use the userVerification property.

Default

- false

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:70

signInAliases?

readonly optional signInAliases: any

Methods in which a user registers or signs in to a user pool. Allows either username with aliases OR sign in with email, phone, or both.

Read the sections on usernames and aliases to learn more - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

To match with ‘Option 1’ in the above link, with a verified email, this property should be set to { username: true, email: true }. To match with ‘Option 2’ in the above link with both a verified email and phone number, this property should be set to { email: true, phone: true }.

Default

{ username: true }

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:112

signInCaseSensitive?

readonly optional signInCaseSensitive: boolean

Whether sign-in aliases should be evaluated with case sensitivity. For example, when this option is set to false, users will be able to sign in using either MyUsername or myusername.

Default

true

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:172

snsRegion?

readonly optional snsRegion: string

The region to integrate with SNS to send SMS messages.

This property will do nothing if SMS configuration is not configured.

Default

- The same region as the user pool, with a few exceptions - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html#user-pool-sms-settings-first-time

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:91

standardAttributes?

readonly optional standardAttributes: any

The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html

Default

- All standard attributes are optional and mutable.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:134

userInvitation?

readonly optional userInvitation: any

Configuration around admins signing up users into a user pool.

Default

- see defaults in UserInvitationConfig.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:83

userVerification?

readonly optional userVerification: any

Configuration around users signing themselves up to the user pool. Enable or disable self sign-up via the selfSignUpEnabled property.

Default

- see defaults in UserVerificationConfig.

Defined in

@meltmedia/totem/lib/services/user-manager/types.d.ts:77