UserPoolBuilder (FsCDK)

UserPoolBuilder Type

Namespace: FsCDK
Assembly: FsCDK.dll
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`UserPoolBuilder(name)` Full Usage: `UserPoolBuilder(name)` Parameters: name : `string` Returns: `UserPoolBuilder`	name : `string` Returns: `UserPoolBuilder`


                
                  
                    
                      UserPoolBuilder(name)

Full Usage: UserPoolBuilder(name)

Parameters:

name : string

Returns: UserPoolBuilder

name : string

Returns: UserPoolBuilder

Instance members

Instance member	Description
`accountRecovery recovery` Full Usage: `accountRecovery recovery` Parameters: recovery : `AccountRecovery` Returns: `UserPoolConfig`	Sets account recovery method. recovery : `AccountRecovery` Returns: `UserPoolConfig`
`autoVerify attrs` Full Usage: `autoVerify attrs` Parameters: attrs : `IAutoVerifiedAttrs` Returns: `UserPoolConfig`	Sets auto-verification attributes. attrs : `IAutoVerifiedAttrs` Returns: `UserPoolConfig`
`this.Combine` Full Usage: `this.Combine` Parameters: a : `UserPoolConfig` b : `UserPoolConfig` Returns: `UserPoolConfig`	a : `UserPoolConfig` b : `UserPoolConfig` Returns: `UserPoolConfig`
`constructId id` Full Usage: `constructId id` Parameters: id : `string` Returns: `UserPoolConfig`	Sets the construct ID for the user pool. id : `string` Returns: `UserPoolConfig`
`customAttribute attr` Full Usage: `customAttribute attr` Parameters: attr : `ICustomAttribute` Returns: `UserPoolConfig`	Add a custom attribute (key derived from attribute type name). attr : `ICustomAttribute` Returns: `UserPoolConfig`
`this.Delay` Full Usage: `this.Delay` Parameters: f : `unit -> UserPoolConfig` Returns: `UserPoolConfig` Modifiers: inline	f : `unit -> UserPoolConfig` Returns: `UserPoolConfig`
`emailSettings settings` Full Usage: `emailSettings settings` Parameters: settings : `UserPoolEmail` Returns: `UserPoolConfig`	Sets email settings. settings : `UserPoolEmail` Returns: `UserPoolConfig`
`this.For` Full Usage: `this.For` Parameters: config : `UserPoolConfig` f : `unit -> UserPoolConfig` Returns: `UserPoolConfig` Modifiers: inline	config : `UserPoolConfig` f : `unit -> UserPoolConfig` Returns: `UserPoolConfig`
`lambdaTriggers triggers` Full Usage: `lambdaTriggers triggers` Parameters: triggers : `IUserPoolTriggers` Returns: `UserPoolConfig`	Sets Lambda triggers for the user pool. triggers : `IUserPoolTriggers` Returns: `UserPoolConfig`
`mfa mfa` Full Usage: `mfa mfa` Parameters: mfa : `Mfa` Returns: `UserPoolConfig`	Sets MFA configuration. mfa : `Mfa` Returns: `UserPoolConfig`
`mfaSecondFactor secondFactor` Full Usage: `mfaSecondFactor secondFactor` Parameters: secondFactor : `IMfaSecondFactor` Returns: `UserPoolConfig`	Sets MFA second factor configuration. secondFactor : `IMfaSecondFactor` Returns: `UserPoolConfig`
`passwordPolicy policy` Full Usage: `passwordPolicy policy` Parameters: policy : `IPasswordPolicy` Returns: `UserPoolConfig`	Sets password policy. policy : `IPasswordPolicy` Returns: `UserPoolConfig`
`removalPolicy policy` Full Usage: `removalPolicy policy` Parameters: policy : `RemovalPolicy` Returns: `UserPoolConfig`	Sets the removal policy for the user pool. policy : `RemovalPolicy` Returns: `UserPoolConfig`
`this.Run` Full Usage: `this.Run` Parameters: config : `UserPoolConfig` Returns: `UserPoolSpec`	config : `UserPoolConfig` Returns: `UserPoolSpec`
`selfSignUpEnabled enabled` Full Usage: `selfSignUpEnabled enabled` Parameters: enabled : `bool` Returns: `UserPoolConfig`	Enables or disables self sign-up. enabled : `bool` Returns: `UserPoolConfig`
`signInAliases aliases` Full Usage: `signInAliases aliases` Parameters: aliases : `ISignInAliases` Returns: `UserPoolConfig`	Sets sign-in aliases. aliases : `ISignInAliases` Returns: `UserPoolConfig`
`signInWithEmail` Full Usage: `signInWithEmail` Returns: `UserPoolConfig`	Enables email only as sign-in alias. Returns: `UserPoolConfig`
`signInWithEmailAndUsername` Full Usage: `signInWithEmailAndUsername` Returns: `UserPoolConfig`	Enables email and username as sign-in aliases. Returns: `UserPoolConfig`
`smsRole role` Full Usage: `smsRole role` Parameters: role : `IRole` Returns: `UserPoolConfig`	Sets the SMS role for the user pool. role : `IRole` Returns: `UserPoolConfig`
`standardAttributes attrs` Full Usage: `standardAttributes attrs` Parameters: attrs : `IStandardAttributes` Returns: `UserPoolConfig`	Sets standard attributes. attrs : `IStandardAttributes` Returns: `UserPoolConfig`
`userPoolName name` Full Usage: `userPoolName name` Parameters: name : `string` Returns: `UserPoolConfig`	Sets the user pool name. name : `string` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: triggers : `IUserPoolTriggers` Returns: `UserPoolConfig`	triggers : `IUserPoolTriggers` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: mfaSecondFactor : `IMfaSecondFactor` Returns: `UserPoolConfig`	mfaSecondFactor : `IMfaSecondFactor` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: customAttr : `ICustomAttribute` Returns: `UserPoolConfig`	customAttr : `ICustomAttribute` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: standardAttrs : `IStandardAttributes` Returns: `UserPoolConfig`	standardAttrs : `IStandardAttributes` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: autoVerified : `IAutoVerifiedAttrs` Returns: `UserPoolConfig`	autoVerified : `IAutoVerifiedAttrs` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: signInAliases : `ISignInAliases` Returns: `UserPoolConfig`	signInAliases : `ISignInAliases` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: passwordPolicy : `IPasswordPolicy` Returns: `UserPoolConfig`	passwordPolicy : `IPasswordPolicy` Returns: `UserPoolConfig`
`this.Yield` Full Usage: `this.Yield` Parameters: () : `unit` Returns: `UserPoolConfig`	() : `unit` Returns: `UserPoolConfig`
`this.Zero` Full Usage: `this.Zero` Returns: `UserPoolConfig`	Returns: `UserPoolConfig`