Package software.amazon.awscdk.services.cognito

Class CfnUserPoolDomainProps.Builder

java.lang.Object
software.amazon.awscdk.services.cognito.CfnUserPoolDomainProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPoolDomainProps>
Enclosing interface:
CfnUserPoolDomainProps
@Stability(Stable) public static final class CfnUserPoolDomainProps.Builder extends Object implements software.amazon.jsii.Builder<CfnUserPoolDomainProps>
A builder for CfnUserPoolDomainProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • domain

      @Stability(Stable) public CfnUserPoolDomainProps.Builder domain(String domain)
      Sets the value of CfnUserPoolDomainProps.getDomain()
      Parameters:
      domain - The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. This parameter is required. 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:
      this

    • userPoolId

      @Stability(Stable) public CfnUserPoolDomainProps.Builder userPoolId(String userPoolId)
      Sets the value of CfnUserPoolDomainProps.getUserPoolId()
      Parameters:
      userPoolId - The ID of the user pool that is associated with the custom domain whose certificate you're updating. This parameter is required.
      Returns:
      this

    • customDomainConfig

      @Stability(Stable) public CfnUserPoolDomainProps.Builder customDomainConfig(IResolvable customDomainConfig)
      Sets the value of CfnUserPoolDomainProps.getCustomDomainConfig()
      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:
      this

    • customDomainConfig

      @Stability(Stable) public CfnUserPoolDomainProps.Builder customDomainConfig(CfnUserPoolDomain.CustomDomainConfigTypeProperty customDomainConfig)
      Sets the value of CfnUserPoolDomainProps.getCustomDomainConfig()
      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:
      this

    • managedLoginVersion

      @Stability(Stable) public CfnUserPoolDomainProps.Builder managedLoginVersion(Number managedLoginVersion)
      Sets the value of CfnUserPoolDomainProps.getManagedLoginVersion()
      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:
      this

    • build

      @Stability(Stable) public CfnUserPoolDomainProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnUserPoolDomainProps>
      Returns:
      a new instance of CfnUserPoolDomainProps
      Throws:
      NullPointerException - if any required attribute was not provided