UserPoolProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.cognito.UserPoolProps.Jsii$Proxy

All Implemented Interfaces:: UserPoolProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: UserPoolProps

@Stability(value=Stable)
 @Internal
public static final class UserPoolProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements UserPoolProps

An implementation for UserPoolProps

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.UserPoolProps
  UserPoolProps.Builder, UserPoolProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.
`protected`	`Jsii$Proxy(UserPoolProps.Builder builder)` Constructor that initializes the object based on literal property values passed by the `UserPoolProps.Builder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`AccountRecovery`	`getAccountRecovery()` How will a user be able to recover their account?
`AutoVerifiedAttrs`	`getAutoVerify()` Attributes which Cognito will look to verify automatically upon user sign up.
`Map<String,ICustomAttribute>`	`getCustomAttributes()` Define a set of custom attributes that can be configured for each user in the user pool.
`IKey`	`getCustomSenderKmsKey()` This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates.
`DeviceTracking`	`getDeviceTracking()` Device tracking settings.
`UserPoolEmail`	`getEmail()` Email settings for a user pool.
`Boolean`	`getEnableSmsRole()` Setting this would explicitly enable or disable SMS role creation.
`KeepOriginalAttrs`	`getKeepOriginal()` Attributes which Cognito will look to handle changes to the value of your users' email address and phone number attributes.
`UserPoolTriggers`	`getLambdaTriggers()` Lambda functions to use for supported Cognito triggers.
`Mfa`	`getMfa()` Configure whether users of this user pool can or are required use MFA to sign in.
`String`	`getMfaMessage()` The SMS message template sent during MFA verification.
`MfaSecondFactor`	`getMfaSecondFactor()` Configure the MFA types that users can use in this user pool.
`PasswordPolicy`	`getPasswordPolicy()` Password policy for this user pool.
`RemovalPolicy`	`getRemovalPolicy()` Policy to apply when the user pool is removed from the stack.
`Boolean`	`getSelfSignUpEnabled()` Whether self sign up should be enabled.
`SignInAliases`	`getSignInAliases()` Methods in which a user registers or signs in to a user pool.
`Boolean`	`getSignInCaseSensitive()` Whether sign-in aliases should be evaluated with case sensitivity.
`IRole`	`getSmsRole()` The IAM role that Cognito will assume while sending SMS messages.
`String`	`getSmsRoleExternalId()` The 'ExternalId' that Cognito service must using when assuming the `smsRole`, if the role is restricted with an 'sts:ExternalId' conditional.
`String`	`getSnsRegion()` The region to integrate with SNS to send SMS messages.
`StandardAttributes`	`getStandardAttributes()` The set of attributes that are required for every user in the user pool.
`UserInvitationConfig`	`getUserInvitation()` Configuration around admins signing up users into a user pool.
`String`	`getUserPoolName()` Name of the user pool.
`UserVerificationConfig`	`getUserVerification()` Configuration around users signing themselves up to the user pool.
`int`	`hashCode()`

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolProps
builder

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
  - Jsii$Proxy
```
protected Jsii$Proxy(UserPoolProps.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the UserPoolProps.Builder.
- Method Detail
  - getAccountRecovery
```
public final AccountRecovery getAccountRecovery()
```
    Description copied from interface: UserPoolProps
    
    How will a user be able to recover their account?
    Default: AccountRecovery.PHONE_WITHOUT_MFA_AND_EMAIL
    
    Specified by:
    
    getAccountRecovery in interface UserPoolProps
  - getAutoVerify
```
public final AutoVerifiedAttrs getAutoVerify()
```
    Description copied from interface: UserPoolProps
    
    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.
    
    Specified by:
    
    getAutoVerify in interface UserPoolProps
  - getCustomAttributes
```
public final Map<String,ICustomAttribute> getCustomAttributes()
```
    Description copied from interface: UserPoolProps
    
    Define a set of custom attributes that can be configured for each user in the user pool.
    Default: - No custom attributes.
    
    Specified by:
    
    getCustomAttributes in interface UserPoolProps
  - getCustomSenderKmsKey
```
public final IKey getCustomSenderKmsKey()
```
    Description copied from interface: UserPoolProps
    
    This key will be used to encrypt temporary passwords and authorization codes that Amazon Cognito generates.
    Default: - no key ID configured
    
    Specified by:
    
    getCustomSenderKmsKey in interface UserPoolProps
    
    See Also:
    
    https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-sender-triggers.html
  - getDeviceTracking
```
public final DeviceTracking getDeviceTracking()
```
    Description copied from interface: UserPoolProps
    
    Device tracking settings.
    Default: - see defaults on each property of DeviceTracking.
    
    Specified by:
    
    getDeviceTracking in interface UserPoolProps
  - getEmail
```
public final UserPoolEmail getEmail()
```
    Description copied from interface: UserPoolProps
    
    Email settings for a user pool.
    Default: - cognito will use the default email configuration
    
    Specified by:
    
    getEmail in interface UserPoolProps
  - getEnableSmsRole
```
public final Boolean getEnableSmsRole()
```
    Description copied from interface: UserPoolProps
    
    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.
    
    Specified by:
    
    getEnableSmsRole in interface UserPoolProps
  - getKeepOriginal
```
public final KeepOriginalAttrs getKeepOriginal()
```
    Description copied from interface: UserPoolProps
    
    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.
    
    Specified by:
    
    getKeepOriginal in interface UserPoolProps
  - getLambdaTriggers
```
public final UserPoolTriggers getLambdaTriggers()
```
    Description copied from interface: UserPoolProps
    
    Lambda functions to use for supported Cognito triggers.
    Default: - No Lambda triggers.
    
    Specified by:
    
    getLambdaTriggers in interface UserPoolProps
    
    See Also:
    
    https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html
  - getMfa
```
public final Mfa getMfa()
```
    Description copied from interface: UserPoolProps
    
    Configure whether users of this user pool can or are required use MFA to sign in.
    Default: Mfa.OFF
    
    Specified by:
    
    getMfa in interface UserPoolProps
  - getMfaMessage
```
public final String getMfaMessage()
```
    Description copied from interface: UserPoolProps
    
    The SMS message template sent during MFA verification.
    Use '{####}' in the template where Cognito should insert the verification code.
    Default: 'Your authentication code is {####}.'
    
    Specified by:
    
    getMfaMessage in interface UserPoolProps
  - getMfaSecondFactor
```
public final MfaSecondFactor getMfaSecondFactor()
```
    Description copied from interface: UserPoolProps
    
    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
    
    Specified by:
    
    getMfaSecondFactor in interface UserPoolProps
  - getPasswordPolicy
```
public final PasswordPolicy getPasswordPolicy()
```
    Description copied from interface: UserPoolProps
    
    Password policy for this user pool.
    Default: - see defaults on each property of PasswordPolicy.
    
    Specified by:
    
    getPasswordPolicy in interface UserPoolProps
  - getRemovalPolicy
```
public final RemovalPolicy getRemovalPolicy()
```
    Description copied from interface: UserPoolProps
    
    Policy to apply when the user pool is removed from the stack.
    Default: RemovalPolicy.RETAIN
    
    Specified by:
    
    getRemovalPolicy in interface UserPoolProps
  - getSelfSignUpEnabled
```
public final Boolean getSelfSignUpEnabled()
```
    Description copied from interface: UserPoolProps
    
    Whether self sign up should be enabled.
    This can be further configured via the selfSignUp property.
    Default: false
    
    Specified by:
    
    getSelfSignUpEnabled in interface UserPoolProps
  - getSignInAliases
```
public final SignInAliases getSignInAliases()
```
    Description copied from interface: UserPoolProps
    
    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 }
    
    Specified by:
    
    getSignInAliases in interface UserPoolProps
  - getSignInCaseSensitive
```
public final Boolean getSignInCaseSensitive()
```
    Description copied from interface: UserPoolProps
    
    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
    
    Specified by:
    
    getSignInCaseSensitive in interface UserPoolProps
  - getSmsRole
```
public final IRole getSmsRole()
```
    Description copied from interface: UserPoolProps
    
    The IAM role that Cognito will assume while sending SMS messages.
    Default: - a new IAM role is created
    
    Specified by:
    
    getSmsRole in interface UserPoolProps
  - getSmsRoleExternalId
```
public final String getSmsRoleExternalId()
```
    Description copied from interface: UserPoolProps
    
    The 'ExternalId' that Cognito service must using when assuming the `smsRole`, if the role is restricted with an 'sts:ExternalId' conditional.
    Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html
    This property will be ignored if smsRole is not specified.
    Default: - No external id will be configured
    
    Specified by:
    
    getSmsRoleExternalId in interface UserPoolProps
  - getSnsRegion
```
public final String getSnsRegion()
```
    Description copied from interface: UserPoolProps
    
    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
    
    Specified by:
    
    getSnsRegion in interface UserPoolProps
  - getStandardAttributes
```
public final StandardAttributes getStandardAttributes()
```
    Description copied from interface: UserPoolProps
    
    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.
    
    Specified by:
    
    getStandardAttributes in interface UserPoolProps
  - getUserInvitation
```
public final UserInvitationConfig getUserInvitation()
```
    Description copied from interface: UserPoolProps
    
    Configuration around admins signing up users into a user pool.
    Default: - see defaults in UserInvitationConfig
    
    Specified by:
    
    getUserInvitation in interface UserPoolProps
  - getUserPoolName
```
public final String getUserPoolName()
```
    Description copied from interface: UserPoolProps
    
    Name of the user pool.
    Default: - automatically generated name by CloudFormation at deploy time
    
    Specified by:
    
    getUserPoolName in interface UserPoolProps
  - getUserVerification
```
public final UserVerificationConfig getUserVerification()
```
    Description copied from interface: UserPoolProps
    
    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
    
    Specified by:
    
    getUserVerification in interface UserPoolProps
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class UserPoolProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.UserPoolProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolProps

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getAccountRecovery

getAutoVerify

getCustomAttributes

getCustomSenderKmsKey

getDeviceTracking

getEmail

getEnableSmsRole

getKeepOriginal

getLambdaTriggers

getMfa

getMfaMessage

getMfaSecondFactor

getPasswordPolicy

getRemovalPolicy

getSelfSignUpEnabled

getSignInAliases

getSignInCaseSensitive

getSmsRole

getSmsRoleExternalId

getSnsRegion

getStandardAttributes

getUserInvitation

getUserPoolName

getUserVerification

$jsii$toJson

equals

hashCode