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

Interface UpdateUserPoolDomainRequest.Builder

    • Method Detail

      • domain

        UpdateUserPoolDomainRequest.Builder domain​(String domain)

        The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.

        This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

        Parameters:
        domain - The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.

        This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.

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

      • userPoolId

        UpdateUserPoolDomainRequest.Builder userPoolId​(String userPoolId)

        The ID of the user pool that is associated with the custom domain whose certificate you're updating.

        Parameters:
        userPoolId - The ID of the user pool that is associated with the custom domain whose certificate you're updating.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • managedLoginVersion

        UpdateUserPoolDomainRequest.Builder managedLoginVersion​(Integer managedLoginVersion)

        A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login.

        Parameters:
        managedLoginVersion - A version number that indicates the state of managed login for your domain. Version 1 is hosted UI (classic). Version 2 is the newer managed login with the branding designer. For more information, see Managed login.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customDomainConfig

        UpdateUserPoolDomainRequest.Builder customDomainConfig​(CustomDomainConfigType customDomainConfig)

        The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

        When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a SetUserPoolMfaConfig request.

        Parameters:
        customDomainConfig - The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

        When you create a custom domain, the passkey RP ID defaults to the custom domain. If you had a prefix domain active, this will cause passkey integration for your prefix domain to stop working due to a mismatch in RP ID. To keep the prefix domain passkey integration working, you can explicitly set RP ID to the prefix domain. Update the RP ID in a SetUserPoolMfaConfig request.

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