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

Class UpdateUserPoolDomainRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest
software.amazon.awssdk.services.cognitoidentityprovider.model.UpdateUserPoolDomainRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateUserPoolDomainRequest.Builder,UpdateUserPoolDomainRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateUserPoolDomainRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<UpdateUserPoolDomainRequest.Builder,UpdateUserPoolDomainRequest>

The UpdateUserPoolDomain request input.

  • Method Details

    • domain

      public final 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.

      Returns:
      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.

    • userPoolId

      public final String userPoolId()

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

      Returns:
      The ID of the user pool that is associated with the domain you're updating.

    • managedLoginVersion

      public final 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 editor. For more information, see Managed login.

      Returns:
      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 editor. For more information, see Managed login.

    • customDomainConfig

      public final 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.

      Returns:
      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.

    • routing

      public final RoutingType routing()

      The routing configuration for the user pool domain. Specifies failover settings for multi-region deployments.

      Returns:
      The routing configuration for the user pool domain. Specifies failover settings for multi-region deployments.

    • toBuilder

      public UpdateUserPoolDomainRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateUserPoolDomainRequest.Builder,UpdateUserPoolDomainRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest

    • builder

      public static UpdateUserPoolDomainRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateUserPoolDomainRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo