Package com.pulumi.aws.cognito.inputs

Class UserPoolState.Builder

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

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • accountRecoverySetting

        public UserPoolState.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 UserPoolState.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 UserPoolState.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 UserPoolState.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: `phone_number`, `email`, or `preferred_username`. Conflicts with `username_attributes`.
        Returns:
        builder

      • aliasAttributes

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

      • aliasAttributes

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

      • arn

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

      • arn

        public UserPoolState.Builder arn​(java.lang.String arn)
        Parameters:
        arn - ARN of the user pool.
        Returns:
        builder

      • autoVerifiedAttributes

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

      • autoVerifiedAttributes

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

      • autoVerifiedAttributes

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

      • creationDate

        public UserPoolState.Builder creationDate​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> creationDate)
        Parameters:
        creationDate - Date the user pool was created.
        Returns:
        builder

      • creationDate

        public UserPoolState.Builder creationDate​(java.lang.String creationDate)
        Parameters:
        creationDate - Date the user pool was created.
        Returns:
        builder

      • customDomain

        public UserPoolState.Builder customDomain​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> customDomain)
        Parameters:
        customDomain - A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: `auth.example.com`.
        Returns:
        builder

      • customDomain

        public UserPoolState.Builder customDomain​(java.lang.String customDomain)
        Parameters:
        customDomain - A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: `auth.example.com`.
        Returns:
        builder

      • deletionProtection

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

      • domain

        public UserPoolState.Builder domain​(@Nullable
                                    com.pulumi.core.Output<java.lang.String> domain)
        Parameters:
        domain - Holds the domain prefix if the user pool has a domain associated with it.
        Returns:
        builder

      • domain

        public UserPoolState.Builder domain​(java.lang.String domain)
        Parameters:
        domain - Holds the domain prefix if the user pool has a domain associated with it.
        Returns:
        builder

      • emailConfiguration

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

      • emailVerificationMessage

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

      • emailVerificationMessage

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

      • emailVerificationSubject

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

      • emailVerificationSubject

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

      • endpoint

        public UserPoolState.Builder endpoint​(@Nullable
                                      com.pulumi.core.Output<java.lang.String> endpoint)
        Parameters:
        endpoint - Endpoint name of the user pool. Example format: `cognito-idp.REGION.amazonaws.com/xxxx_yyyyy`
        Returns:
        builder

      • endpoint

        public UserPoolState.Builder endpoint​(java.lang.String endpoint)
        Parameters:
        endpoint - Endpoint name of the user pool. Example format: `cognito-idp.REGION.amazonaws.com/xxxx_yyyyy`
        Returns:
        builder

      • estimatedNumberOfUsers

        public UserPoolState.Builder estimatedNumberOfUsers​(@Nullable
                                                    com.pulumi.core.Output<java.lang.Integer> estimatedNumberOfUsers)
        Parameters:
        estimatedNumberOfUsers - A number estimating the size of the user pool.
        Returns:
        builder

      • estimatedNumberOfUsers

        public UserPoolState.Builder estimatedNumberOfUsers​(java.lang.Integer estimatedNumberOfUsers)
        Parameters:
        estimatedNumberOfUsers - A number estimating the size of the user pool.
        Returns:
        builder

      • lambdaConfig

        public UserPoolState.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 UserPoolState.Builder lambdaConfig​(UserPoolLambdaConfigArgs lambdaConfig)
        Parameters:
        lambdaConfig - Configuration block for the AWS Lambda triggers associated with the user pool. Detailed below.
        Returns:
        builder

      • lastModifiedDate

        public UserPoolState.Builder lastModifiedDate​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> lastModifiedDate)
        Parameters:
        lastModifiedDate - Date the user pool was last modified.
        Returns:
        builder

      • lastModifiedDate

        public UserPoolState.Builder lastModifiedDate​(java.lang.String lastModifiedDate)
        Parameters:
        lastModifiedDate - Date the user pool was last modified.
        Returns:
        builder

      • mfaConfiguration

        public UserPoolState.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 `sms_configuration` or `software_token_mfa_configuration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured).
        Returns:
        builder

      • mfaConfiguration

        public UserPoolState.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 `sms_configuration` or `software_token_mfa_configuration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured).
        Returns:
        builder

      • name

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

      • name

        public UserPoolState.Builder name​(java.lang.String name)
        Parameters:
        name - Name of the user pool. The following arguments are optional:
        Returns:
        builder

      • passwordPolicy

        public UserPoolState.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 UserPoolState.Builder passwordPolicy​(UserPoolPasswordPolicyArgs passwordPolicy)
        Parameters:
        passwordPolicy - Configuration block for information about the user pool password policy. Detailed below.
        Returns:
        builder

      • schemas

        public UserPoolState.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 UserPoolState.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 UserPoolState.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

      • smsAuthenticationMessage

        public UserPoolState.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 UserPoolState.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 UserPoolState.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). 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 UserPoolState.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). 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 UserPoolState.Builder smsVerificationMessage​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> smsVerificationMessage)
        Parameters:
        smsVerificationMessage - String representing the SMS verification message. Conflicts with `verification_message_template` configuration block `sms_message` argument.
        Returns:
        builder

      • smsVerificationMessage

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

      • softwareTokenMfaConfiguration

        public UserPoolState.Builder softwareTokenMfaConfiguration​(@Nullable
                                                           com.pulumi.core.Output<UserPoolSoftwareTokenMfaConfigurationArgs> softwareTokenMfaConfiguration)
        Parameters:
        softwareTokenMfaConfiguration - Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
        Returns:
        builder

      • softwareTokenMfaConfiguration

        public UserPoolState.Builder softwareTokenMfaConfiguration​(UserPoolSoftwareTokenMfaConfigurationArgs softwareTokenMfaConfiguration)
        Parameters:
        softwareTokenMfaConfiguration - Configuration block for software token Mult-Factor Authentication (MFA) settings. Detailed below.
        Returns:
        builder

      • tags

        public UserPoolState.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 `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tags

        public UserPoolState.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 `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tagsAll

        @Deprecated
public UserPoolState.Builder tagsAll​(@Nullable
                                     com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll)
        Deprecated.
        Please use `tags` instead.
        Parameters:
        tagsAll - A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
        Returns:
        builder

      • tagsAll

        @Deprecated
public UserPoolState.Builder tagsAll​(java.util.Map<java.lang.String,​java.lang.String> tagsAll)
        Deprecated.
        Please use `tags` instead.
        Parameters:
        tagsAll - A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
        Returns:
        builder

      • userAttributeUpdateSettings

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

      • userPoolAddOns

        public UserPoolState.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 UserPoolState.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

      • usernameAttributes

        public UserPoolState.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 `alias_attributes`.
        Returns:
        builder

      • usernameAttributes

        public UserPoolState.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 `alias_attributes`.
        Returns:
        builder

      • usernameAttributes

        public UserPoolState.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 `alias_attributes`.
        Returns:
        builder

      • usernameConfiguration

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

      • verificationMessageTemplate

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