Package software.amazon.awscdk.services.cognito

Class UserPoolProps.Jsii$Proxy

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(Stable) @Internal public static final class UserPoolProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements UserPoolProps
An implementation for UserPoolProps

  • Constructor Details

    • 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 Details

    • 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

    • getAdvancedSecurityMode

      public final AdvancedSecurityMode getAdvancedSecurityMode()
      Description copied from interface: UserPoolProps
      (deprecated) The user pool's Advanced Security Mode.

      Default: - no value

      Specified by:
      getAdvancedSecurityMode 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 IKeyRef 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:

    • getCustomThreatProtectionMode

      public final CustomThreatProtectionMode getCustomThreatProtectionMode()
      Description copied from interface: UserPoolProps
      The Type of Threat Protection Enabled for Custom Authentication.

      This feature only functions if your FeaturePlan is set to FeaturePlan.PLUS

      Default: - no value

      Specified by:
      getCustomThreatProtectionMode in interface UserPoolProps
      See Also:

    • getDeletionProtection

      public final Boolean getDeletionProtection()
      Description copied from interface: UserPoolProps
      Indicates whether the user pool should have deletion protection enabled.

      Default: false

      Specified by:
      getDeletionProtection in interface UserPoolProps

    • 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

    • getFeaturePlan

      public final FeaturePlan getFeaturePlan()
      Description copied from interface: UserPoolProps
      The user pool feature plan, or tier.

      This parameter determines the eligibility of the user pool for features like managed login, access-token customization, and threat protection.

      Default: - FeaturePlan.ESSENTIALS for a newly created user pool; FeaturePlan.LITE otherwise

      Specified by:
      getFeaturePlan in interface UserPoolProps
      See Also:

    • 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:

    • 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, email: false }, if `mfa` is set to `OPTIONAL` or `REQUIRED`. { sms: false, otp: false, email:false }, otherwise

      Specified by:
      getMfaSecondFactor in interface UserPoolProps

    • getPasskeyRelyingPartyId

      public final String getPasskeyRelyingPartyId()
      Description copied from interface: UserPoolProps
      The authentication domain that passkey providers must use as a relying party (RP) in their configuration.

      Under the following conditions, the passkey relying party ID must be the fully-qualified domain name of your custom domain:

      • The user pool is configured for passkey authentication.
      • The user pool has a custom domain, whether or not it also has a prefix domain.
      • Your application performs authentication with managed login or the classic hosted UI.

      Default: - No authentication domain

      Specified by:
      getPasskeyRelyingPartyId in interface UserPoolProps

    • getPasskeyUserVerification

      public final PasskeyUserVerification getPasskeyUserVerification()
      Description copied from interface: UserPoolProps
      Your user-pool treatment for MFA with a passkey.

      You can override other MFA options and require passkey MFA, or you can set it as preferred. When passkey MFA is preferred, the hosted UI encourages users to register a passkey at sign-in.

      Default: - Cognito default setting is PasskeyUserVerification.PREFERRED

      Specified by:
      getPasskeyUserVerification 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.

      To configure self sign-up configuration use the userVerification 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

    • getSignInPolicy

      public final SignInPolicy getSignInPolicy()
      Description copied from interface: UserPoolProps
      Sign-in policy for this user pool.

      Default: - see defaults on each property of SignInPolicy.

      Specified by:
      getSignInPolicy in interface UserPoolProps

    • getSmsRole

      public final IRoleRef 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 be 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

    • getStandardThreatProtectionMode

      public final StandardThreatProtectionMode getStandardThreatProtectionMode()
      Description copied from interface: UserPoolProps
      The Type of Threat Protection Enabled for Standard Authentication.

      This feature only functions if your FeaturePlan is set to FeaturePlan.PLUS

      Default: - StandardThreatProtectionMode.NO_ENFORCEMENT

      Specified by:
      getStandardThreatProtectionMode in interface UserPoolProps
      See Also:

    • 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