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 Amazon Cognito prefix domains, this is the prefix alone, such as auth.

      Returns:
      The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

    • userPoolId

      public final String userPoolId()

      The user pool ID.

      Returns:
      The user pool ID.

    • customDomainConfig

      public final CustomDomainConfigType customDomainConfig()

      The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

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

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

      Returns:
      The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

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

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

    • toBuilder

      public CreateUserPoolDomainRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateUserPoolDomainRequest.Builder,CreateUserPoolDomainRequest>
      Specified by:
      toBuilder in class CognitoIdentityProviderRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.