Interface UpdateUserPoolDomainRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateUserPoolDomainRequest.Builder,UpdateUserPoolDomainRequest>, SdkBuilder<UpdateUserPoolDomainRequest.Builder,UpdateUserPoolDomainRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateUserPoolDomainRequest
@Mutable @NotThreadSafe public static interface UpdateUserPoolDomainRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserPoolDomainRequest.Builder,UpdateUserPoolDomainRequest>

  • Method Details

    • domain

      UpdateUserPoolDomainRequest.Builder domain(String domain)

      The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com. For prefix domains, this is the prefix alone, such as myprefix.

      Parameters:
      domain - The name of the domain that you want to update. For custom domains, this is the fully-qualified domain name, for example auth.example.com. For prefix domains, this is the prefix alone, such as myprefix.
      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 domain you're updating.

      Parameters:
      userPoolId - The ID of the user pool that is associated with the domain 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 managed login for your application. In an UpdateUserPoolDomain request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN in us-east-1.

      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.

      Parameters:
      customDomainConfig - The configuration for a custom domain that hosts managed login for your application. In an UpdateUserPoolDomain request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN in us-east-1.

      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.

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

    • customDomainConfig

      default UpdateUserPoolDomainRequest.Builder customDomainConfig(Consumer<CustomDomainConfigType.Builder> customDomainConfig)

      The configuration for a custom domain that hosts managed login for your application. In an UpdateUserPoolDomain request, this parameter specifies an SSL certificate for the managed login hosted webserver. The certificate must be an ACM ARN in us-east-1.

      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.

      This is a convenience method that creates an instance of the CustomDomainConfigType.Builder avoiding the need to create one manually via CustomDomainConfigType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customDomainConfig(CustomDomainConfigType).

      Parameters:
      customDomainConfig - a consumer that will call methods on CustomDomainConfigType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateUserPoolDomainRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateUserPoolDomainRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.