Package com.pulumi.aws.cognito

Class UserPoolArgs.Builder

  • Enclosing class:
    UserPoolArgs
    public static final class UserPoolArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • accountRecoverySetting

        public UserPoolArgs.Builder accountRecoverySetting​(@Nullable
                                                   com.pulumi.core.Output<UserPoolAccountRecoverySettingArgs> accountRecoverySetting)
        Parameters:
        accountRecoverySetting - Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
        Returns:
        builder

      • accountRecoverySetting

        public UserPoolArgs.Builder accountRecoverySetting​(UserPoolAccountRecoverySettingArgs accountRecoverySetting)
        Parameters:
        accountRecoverySetting - Configuration block to define which verified available method a user can use to recover their forgotten password. Detailed below.
        Returns:
        builder

      • adminCreateUserConfig

        public UserPoolArgs.Builder adminCreateUserConfig​(@Nullable
                                                  com.pulumi.core.Output<UserPoolAdminCreateUserConfigArgs> adminCreateUserConfig)
        Parameters:
        adminCreateUserConfig - Configuration block for creating a new user profile. Detailed below.
        Returns:
        builder

      • aliasAttributes

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

      • aliasAttributes

        public UserPoolArgs.Builder aliasAttributes​(java.util.List<java.lang.String> aliasAttributes)
        Parameters:
        aliasAttributes - Attributes supported as an alias for this user pool. Valid values: `phoneNumber`, `email`, or `preferredUsername`. Conflicts with `usernameAttributes`.
        Returns:
        builder

      • aliasAttributes

        public UserPoolArgs.Builder aliasAttributes​(java.lang.String... aliasAttributes)
        Parameters:
        aliasAttributes - Attributes supported as an alias for this user pool. Valid values: `phoneNumber`, `email`, or `preferredUsername`. Conflicts with `usernameAttributes`.
        Returns:
        builder

      • autoVerifiedAttributes

        public UserPoolArgs.Builder autoVerifiedAttributes​(@Nullable
                                                   com.pulumi.core.Output<java.util.List<java.lang.String>> autoVerifiedAttributes)
        Parameters:
        autoVerifiedAttributes - Attributes to be auto-verified. Valid values: `email`, `phoneNumber`.
        Returns:
        builder

      • autoVerifiedAttributes

        public UserPoolArgs.Builder autoVerifiedAttributes​(java.util.List<java.lang.String> autoVerifiedAttributes)
        Parameters:
        autoVerifiedAttributes - Attributes to be auto-verified. Valid values: `email`, `phoneNumber`.
        Returns:
        builder

      • autoVerifiedAttributes

        public UserPoolArgs.Builder autoVerifiedAttributes​(java.lang.String... autoVerifiedAttributes)
        Parameters:
        autoVerifiedAttributes - Attributes to be auto-verified. Valid values: `email`, `phoneNumber`.
        Returns:
        builder

      • deletionProtection

        public UserPoolArgs.Builder deletionProtection​(@Nullable
                                               com.pulumi.core.Output<java.lang.String> deletionProtection)
        Parameters:
        deletionProtection - 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`.
        Returns:
        builder

      • deletionProtection

        public UserPoolArgs.Builder deletionProtection​(java.lang.String deletionProtection)
        Parameters:
        deletionProtection - 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`.
        Returns:
        builder

      • deviceConfiguration

        public UserPoolArgs.Builder deviceConfiguration​(@Nullable
                                                com.pulumi.core.Output<UserPoolDeviceConfigurationArgs> deviceConfiguration)
        Parameters:
        deviceConfiguration - Configuration block for the user pool's device tracking. Detailed below.
        Returns:
        builder

      • emailConfiguration

        public UserPoolArgs.Builder emailConfiguration​(@Nullable
                                               com.pulumi.core.Output<UserPoolEmailConfigurationArgs> emailConfiguration)
        Parameters:
        emailConfiguration - Configuration block for configuring email. Detailed below.
        Returns:
        builder

      • emailMfaConfiguration

        public UserPoolArgs.Builder emailMfaConfiguration​(@Nullable
                                                  com.pulumi.core.Output<UserPoolEmailMfaConfigurationArgs> emailMfaConfiguration)
        Parameters:
        emailMfaConfiguration - 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.
        Returns:
        builder

      • emailMfaConfiguration

        public UserPoolArgs.Builder emailMfaConfiguration​(UserPoolEmailMfaConfigurationArgs emailMfaConfiguration)
        Parameters:
        emailMfaConfiguration - 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.
        Returns:
        builder

      • emailVerificationMessage

        public UserPoolArgs.Builder emailVerificationMessage​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> emailVerificationMessage)
        Parameters:
        emailVerificationMessage - String representing the email verification message. Conflicts with `verificationMessageTemplate` configuration block `emailMessage` argument.
        Returns:
        builder

      • emailVerificationMessage

        public UserPoolArgs.Builder emailVerificationMessage​(java.lang.String emailVerificationMessage)
        Parameters:
        emailVerificationMessage - String representing the email verification message. Conflicts with `verificationMessageTemplate` configuration block `emailMessage` argument.
        Returns:
        builder

      • emailVerificationSubject

        public UserPoolArgs.Builder emailVerificationSubject​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> emailVerificationSubject)
        Parameters:
        emailVerificationSubject - String representing the email verification subject. Conflicts with `verificationMessageTemplate` configuration block `emailSubject` argument.
        Returns:
        builder

      • emailVerificationSubject

        public UserPoolArgs.Builder emailVerificationSubject​(java.lang.String emailVerificationSubject)
        Parameters:
        emailVerificationSubject - String representing the email verification subject. Conflicts with `verificationMessageTemplate` configuration block `emailSubject` argument.
        Returns:
        builder

      • lambdaConfig

        public UserPoolArgs.Builder lambdaConfig​(@Nullable
                                         com.pulumi.core.Output<UserPoolLambdaConfigArgs> lambdaConfig)
        Parameters:
        lambdaConfig - Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
        Returns:
        builder

      • lambdaConfig

        public UserPoolArgs.Builder lambdaConfig​(UserPoolLambdaConfigArgs lambdaConfig)
        Parameters:
        lambdaConfig - Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
        Returns:
        builder

      • mfaConfiguration

        public UserPoolArgs.Builder mfaConfiguration​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> mfaConfiguration)
        Parameters:
        mfaConfiguration - 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).
        Returns:
        builder

      • mfaConfiguration

        public UserPoolArgs.Builder mfaConfiguration​(java.lang.String mfaConfiguration)
        Parameters:
        mfaConfiguration - 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).
        Returns:
        builder

      • name

        public UserPoolArgs.Builder name​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name of the user pool.
        Returns:
        builder

      • name

        public UserPoolArgs.Builder name​(java.lang.String name)
        Parameters:
        name - Name of the user pool.
        Returns:
        builder

      • passwordPolicy

        public UserPoolArgs.Builder passwordPolicy​(@Nullable
                                           com.pulumi.core.Output<UserPoolPasswordPolicyArgs> passwordPolicy)
        Parameters:
        passwordPolicy - Configuration block for information about the user pool password policy. Detailed below.
        Returns:
        builder

      • passwordPolicy

        public UserPoolArgs.Builder passwordPolicy​(UserPoolPasswordPolicyArgs passwordPolicy)
        Parameters:
        passwordPolicy - Configuration block for information about the user pool password policy. Detailed below.
        Returns:
        builder

      • region

        public UserPoolArgs.Builder region​(@Nullable
                                   com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public UserPoolArgs.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • schemas

        public UserPoolArgs.Builder schemas​(@Nullable
                                    com.pulumi.core.Output<java.util.List<UserPoolSchemaArgs>> schemas)
        Parameters:
        schemas - 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.
        Returns:
        builder

      • schemas

        public UserPoolArgs.Builder schemas​(java.util.List<UserPoolSchemaArgs> schemas)
        Parameters:
        schemas - 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.
        Returns:
        builder

      • schemas

        public UserPoolArgs.Builder schemas​(UserPoolSchemaArgs... schemas)
        Parameters:
        schemas - 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.
        Returns:
        builder

      • signInPolicy

        public UserPoolArgs.Builder signInPolicy​(@Nullable
                                         com.pulumi.core.Output<UserPoolSignInPolicyArgs> signInPolicy)
        Parameters:
        signInPolicy - Configuration block for information about the user pool sign in policy. Detailed below.
        Returns:
        builder

      • signInPolicy

        public UserPoolArgs.Builder signInPolicy​(UserPoolSignInPolicyArgs signInPolicy)
        Parameters:
        signInPolicy - Configuration block for information about the user pool sign in policy. Detailed below.
        Returns:
        builder

      • smsAuthenticationMessage

        public UserPoolArgs.Builder smsAuthenticationMessage​(@Nullable
                                                     com.pulumi.core.Output<java.lang.String> smsAuthenticationMessage)
        Parameters:
        smsAuthenticationMessage - String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code.
        Returns:
        builder

      • smsAuthenticationMessage

        public UserPoolArgs.Builder smsAuthenticationMessage​(java.lang.String smsAuthenticationMessage)
        Parameters:
        smsAuthenticationMessage - String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code.
        Returns:
        builder

      • smsConfiguration

        public UserPoolArgs.Builder smsConfiguration​(@Nullable
                                             com.pulumi.core.Output<UserPoolSmsConfigurationArgs> smsConfiguration)
        Parameters:
        smsConfiguration - 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.
        Returns:
        builder

      • smsConfiguration

        public UserPoolArgs.Builder smsConfiguration​(UserPoolSmsConfigurationArgs smsConfiguration)
        Parameters:
        smsConfiguration - 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.
        Returns:
        builder

      • smsVerificationMessage

        public UserPoolArgs.Builder smsVerificationMessage​(@Nullable
                                                   com.pulumi.core.Output<java.lang.String> smsVerificationMessage)
        Parameters:
        smsVerificationMessage - String representing the SMS verification message. Conflicts with `verificationMessageTemplate` configuration block `smsMessage` argument.
        Returns:
        builder

      • smsVerificationMessage

        public UserPoolArgs.Builder smsVerificationMessage​(java.lang.String smsVerificationMessage)
        Parameters:
        smsVerificationMessage - String representing the SMS verification message. Conflicts with `verificationMessageTemplate` configuration block `smsMessage` argument.
        Returns:
        builder

      • softwareTokenMfaConfiguration

        public UserPoolArgs.Builder softwareTokenMfaConfiguration​(@Nullable
                                                          com.pulumi.core.Output<UserPoolSoftwareTokenMfaConfigurationArgs> softwareTokenMfaConfiguration)
        Parameters:
        softwareTokenMfaConfiguration - Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when `mfaConfiguration` is `ON` or `OPTIONAL`. Detailed below.
        Returns:
        builder

      • softwareTokenMfaConfiguration

        public UserPoolArgs.Builder softwareTokenMfaConfiguration​(UserPoolSoftwareTokenMfaConfigurationArgs softwareTokenMfaConfiguration)
        Parameters:
        softwareTokenMfaConfiguration - Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when `mfaConfiguration` is `ON` or `OPTIONAL`. Detailed below.
        Returns:
        builder

      • tags

        public UserPoolArgs.Builder tags​(@Nullable
                                 com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public UserPoolArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • userAttributeUpdateSettings

        public UserPoolArgs.Builder userAttributeUpdateSettings​(@Nullable
                                                        com.pulumi.core.Output<UserPoolUserAttributeUpdateSettingsArgs> userAttributeUpdateSettings)
        Parameters:
        userAttributeUpdateSettings - Configuration block for user attribute update settings. Detailed below.
        Returns:
        builder

      • userPoolAddOns

        public UserPoolArgs.Builder userPoolAddOns​(@Nullable
                                           com.pulumi.core.Output<UserPoolUserPoolAddOnsArgs> userPoolAddOns)
        Parameters:
        userPoolAddOns - Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
        Returns:
        builder

      • userPoolAddOns

        public UserPoolArgs.Builder userPoolAddOns​(UserPoolUserPoolAddOnsArgs userPoolAddOns)
        Parameters:
        userPoolAddOns - Configuration block for user pool add-ons to enable user pool advanced security mode features. Detailed below.
        Returns:
        builder

      • userPoolTier

        public UserPoolArgs.Builder userPoolTier​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> userPoolTier)
        Parameters:
        userPoolTier - 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`.
        Returns:
        builder

      • userPoolTier

        public UserPoolArgs.Builder userPoolTier​(java.lang.String userPoolTier)
        Parameters:
        userPoolTier - 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`.
        Returns:
        builder

      • usernameAttributes

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

      • usernameAttributes

        public UserPoolArgs.Builder usernameAttributes​(java.util.List<java.lang.String> usernameAttributes)
        Parameters:
        usernameAttributes - Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `aliasAttributes`.
        Returns:
        builder

      • usernameAttributes

        public UserPoolArgs.Builder usernameAttributes​(java.lang.String... usernameAttributes)
        Parameters:
        usernameAttributes - Whether email addresses or phone numbers can be specified as usernames when a user signs up. Conflicts with `aliasAttributes`.
        Returns:
        builder

      • usernameConfiguration

        public UserPoolArgs.Builder usernameConfiguration​(@Nullable
                                                  com.pulumi.core.Output<UserPoolUsernameConfigurationArgs> usernameConfiguration)
        Parameters:
        usernameConfiguration - Configuration block for username configuration. Detailed below.
        Returns:
        builder

      • verificationMessageTemplate

        public UserPoolArgs.Builder verificationMessageTemplate​(@Nullable
                                                        com.pulumi.core.Output<UserPoolVerificationMessageTemplateArgs> verificationMessageTemplate)
        Parameters:
        verificationMessageTemplate - Configuration block for verification message templates. Detailed below.
        Returns:
        builder

      • webAuthnConfiguration

        public UserPoolArgs.Builder webAuthnConfiguration​(@Nullable
                                                  com.pulumi.core.Output<UserPoolWebAuthnConfigurationArgs> webAuthnConfiguration)
        Parameters:
        webAuthnConfiguration - Configuration block for web authn configuration. Detailed below.
        Returns:
        builder