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

Interface CreateUserPoolDomainRequest.Builder

    • Method Detail

      • domain

        CreateUserPoolDomainRequest.Builder domain​(String domain)

        The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.

        Parameters:
        domain - The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For prefix domains, this is the prefix alone, such as myprefix. A prefix value of myprefix for a user pool in the us-east-1 Region results in a domain of myprefix.auth.us-east-1.amazoncognito.com.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userPoolId

        CreateUserPoolDomainRequest.Builder userPoolId​(String userPoolId)

        The ID of the user pool where you want to add a domain.

        Parameters:
        userPoolId - The ID of the user pool where you want to add a domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • managedLoginVersion

        CreateUserPoolDomainRequest.Builder managedLoginVersion​(Integer managedLoginVersion)

        The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

        Managed login requires that your user pool be configured for any feature plan other than Lite.

        Parameters:
        managedLoginVersion - The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) and a version of 2 indicates managed login.

        Managed login requires that your user pool be configured for any feature plan other than Lite.

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

      • customDomainConfig

        CreateUserPoolDomainRequest.Builder customDomainConfig​(CustomDomainConfigType customDomainConfig)

        The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

        Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use a prefix domain instead.

        For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

        Parameters:
        customDomainConfig - The configuration for a custom domain. Configures your domain with an Certificate Manager certificate in the us-east-1 Region.

        Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use a prefix domain instead.

        For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

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