Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminCreateUserConfigType.Builder

    • Method Detail

      • allowAdminCreateUserOnly

        AdminCreateUserConfigType.Builder allowAdminCreateUserOnly​(Boolean allowAdminCreateUserOnly)

        The setting for allowing self-service sign-up. When true, only administrators can create new user profiles. When false, users can register themselves and create a new user profile with the SignUp operation.

        Parameters:
        allowAdminCreateUserOnly - The setting for allowing self-service sign-up. When true, only administrators can create new user profiles. When false, users can register themselves and create a new user profile with the SignUp operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • unusedAccountValidityDays

        AdminCreateUserConfigType.Builder unusedAccountValidityDays​(Integer unusedAccountValidityDays)

        This parameter is no longer in use. Configure the duration of temporary passwords with the TemporaryPasswordValidityDays parameter of PasswordPolicyType. For older user pools that have a UnusedAccountValidityDays configuration, that value is effective until you set a value for TemporaryPasswordValidityDays.

        The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call AdminCreateUser again, specifying RESEND for the MessageAction parameter.

        The default value for this parameter is 7.

        Parameters:
        unusedAccountValidityDays - This parameter is no longer in use. Configure the duration of temporary passwords with the TemporaryPasswordValidityDays parameter of PasswordPolicyType. For older user pools that have a UnusedAccountValidityDays configuration, that value is effective until you set a value for TemporaryPasswordValidityDays.

        The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. To reset the account after that time limit, you must call AdminCreateUser again, specifying RESEND for the MessageAction parameter.

        The default value for this parameter is 7.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inviteMessageTemplate

        AdminCreateUserConfigType.Builder inviteMessageTemplate​(MessageTemplateType inviteMessageTemplate)

        The template for the welcome message to new users. This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

        See also Customizing User Invitation Messages.

        Parameters:
        inviteMessageTemplate - The template for the welcome message to new users. This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

        See also Customizing User Invitation Messages.

        Returns:
        Returns a reference to this object so that method calls can be chained together.