Package com.pulumi.aws.cognito

Class UserPoolArgs

  • public final class UserPoolArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • accountRecoverySetting

        public java.util.Optional<com.pulumi.core.Output<UserPoolAccountRecoverySettingArgs>> accountRecoverySetting()
        Returns:
        Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.

      • adminCreateUserConfig

        public java.util.Optional<com.pulumi.core.Output<UserPoolAdminCreateUserConfigArgs>> adminCreateUserConfig()
        Returns:
        Configuration block for creating a new user profile. Detailed below.

      • aliasAttributes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> aliasAttributes()
        Returns:
        Attributes supported as an alias for this user pool. Valid values: `phoneNumber`, `email`, or `preferredUsername`. Conflicts with `usernameAttributes`.

      • autoVerifiedAttributes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> autoVerifiedAttributes()
        Returns:
        Attributes to be auto-verified. Valid values: `email`, `phoneNumber`.

      • deletionProtection

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> deletionProtection()
        Returns:
        When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. Valid values are `ACTIVE` and `INACTIVE`, Default value is `INACTIVE`.

      • deviceConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolDeviceConfigurationArgs>> deviceConfiguration()
        Returns:
        Configuration block for the user pool's device tracking. Detailed below.

      • emailConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolEmailConfigurationArgs>> emailConfiguration()
        Returns:
        Configuration block for configuring email. Detailed below.

      • emailMfaConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolEmailMfaConfigurationArgs>> emailMfaConfiguration()
        Returns:
        Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 `accountRecoverySetting` entries; requires an `emailConfiguration` configuration block. Effective only when `mfaConfiguration` is `ON` or `OPTIONAL`. Detailed below.

      • emailVerificationMessage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> emailVerificationMessage()
        Returns:
        String representing the email verification message. Conflicts with `verificationMessageTemplate` configuration block `emailMessage` argument.

      • emailVerificationSubject

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> emailVerificationSubject()
        Returns:
        String representing the email verification subject. Conflicts with `verificationMessageTemplate` configuration block `emailSubject` argument.

      • lambdaConfig

        public java.util.Optional<com.pulumi.core.Output<UserPoolLambdaConfigArgs>> lambdaConfig()
        Returns:
        Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.

      • mfaConfiguration

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> mfaConfiguration()
        Returns:
        Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `emailMfaConfiguration`, `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `emailMfaConfiguration`, `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured).

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the user pool.

      • passwordPolicy

        public java.util.Optional<com.pulumi.core.Output<UserPoolPasswordPolicyArgs>> passwordPolicy()
        Returns:
        Configuration block for information about the user pool password policy. Detailed below.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • schemas

        public java.util.Optional<com.pulumi.core.Output<java.util.List<UserPoolSchemaArgs>>> schemas()
        Returns:
        Configuration block for the schema attributes of a user pool. Detailed below. Schema attributes from the [standard attribute set](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes) only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes.

      • signInPolicy

        public java.util.Optional<com.pulumi.core.Output<UserPoolSignInPolicyArgs>> signInPolicy()
        Returns:
        Configuration block for information about the user pool sign in policy. Detailed below.

      • smsAuthenticationMessage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> smsAuthenticationMessage()
        Returns:
        String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code.

      • smsConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolSmsConfigurationArgs>> smsConfiguration()
        Returns:
        Configuration block for Short Message Service (SMS) settings. Detailed below. These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). SMS MFA is activated only when `mfaConfiguration` is set to `ON` or `OPTIONAL` along with this block. Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the `taint` command.

      • smsVerificationMessage

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> smsVerificationMessage()
        Returns:
        String representing the SMS verification message. Conflicts with `verificationMessageTemplate` configuration block `smsMessage` argument.

      • softwareTokenMfaConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolSoftwareTokenMfaConfigurationArgs>> softwareTokenMfaConfiguration()
        Returns:
        Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when `mfaConfiguration` is `ON` or `OPTIONAL`. Detailed below.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the User Pool. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • userAttributeUpdateSettings

        public java.util.Optional<com.pulumi.core.Output<UserPoolUserAttributeUpdateSettingsArgs>> userAttributeUpdateSettings()
        Returns:
        Configuration block for user attribute update settings. Detailed below.

      • userPoolAddOns

        public java.util.Optional<com.pulumi.core.Output<UserPoolUserPoolAddOnsArgs>> userPoolAddOns()
        Returns:
        Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.

      • userPoolTier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> userPoolTier()
        Returns:
        The user pool [feature plan](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-sign-in-feature-plans.html), or tier. Valid values: `LITE`, `ESSENTIALS`, `PLUS`.

      • usernameAttributes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> usernameAttributes()
        Returns:
        Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `aliasAttributes`.

      • usernameConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolUsernameConfigurationArgs>> usernameConfiguration()
        Returns:
        Configuration block for username configuration. Detailed below.

      • verificationMessageTemplate

        public java.util.Optional<com.pulumi.core.Output<UserPoolVerificationMessageTemplateArgs>> verificationMessageTemplate()
        Returns:
        Configuration block for verification message templates. Detailed below.

      • webAuthnConfiguration

        public java.util.Optional<com.pulumi.core.Output<UserPoolWebAuthnConfigurationArgs>> webAuthnConfiguration()
        Returns:
        Configuration block for web authn configuration. Detailed below.