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

Class CreateUserPoolDomainRequest

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.CreateUserPoolDomainRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateUserPoolDomainRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>

  • Method Details

    • domain

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

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

    • userPoolId

      public final String userPoolId()

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

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

    • managedLoginVersion

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

      A ManagedLoginVersion value of 2 does not activate managed login pages for your app client. When you create an app client programmatically, your app client has no branding style. To use managed login, create a branding style using the CreateManagedLoginBranding operation. When you use the console, Amazon Cognito assigns a default branding style automatically. When you use the API or an SDK, you must create a branding style yourself.

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

      A ManagedLoginVersion value of 2 does not activate managed login pages for your app client. When you create an app client programmatically, your app client has no branding style. To use managed login, create a branding style using the CreateManagedLoginBranding operation. When you use the console, Amazon Cognito assigns a default branding style automatically. When you use the API or an SDK, you must create a branding style yourself.

    • customDomainConfig

      public final 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 omit this parameter and use a prefix domain instead.

      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. 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 omit this parameter and use a prefix domain instead.

      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 configuration of routing for requests to the domain for replicas of a replicated user pool. The routing configuration is currently only supported for custom domains.

      Returns:
      The configuration of routing for requests to the domain for replicas of a replicated user pool. The routing configuration is currently only supported for custom domains.

    • toBuilder

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

    • builder

      public static CreateUserPoolDomainRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateUserPoolDomainRequest.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