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

Class DomainDescriptionType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.DomainDescriptionType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DomainDescriptionType.Builder,DomainDescriptionType>
@Generated("software.amazon.awssdk:codegen") public final class DomainDescriptionType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DomainDescriptionType.Builder,DomainDescriptionType>

A container for information about a domain.

See Also:

  • Method Details

    • userPoolId

      public final String userPoolId()

      The user pool ID.

      Returns:
      The user pool ID.

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services ID for the user pool owner.

      Returns:
      The Amazon Web Services ID for the user pool owner.

    • 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.

    • s3Bucket

      public final String s3Bucket()

      The Amazon S3 bucket where the static files for this domain are stored.

      Returns:
      The Amazon S3 bucket where the static files for this domain are stored.

    • cloudFrontDistribution

      public final String cloudFrontDistribution()

      The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

      Returns:
      The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

    • version

      public final String version()

      The app version.

      Returns:
      The app version.

    • status

      public final DomainStatusType status()

      The domain status.

      If the service returns an enum value that is not available in the current SDK version, status will return DomainStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The domain status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The domain status.

      If the service returns an enum value that is not available in the current SDK version, status will return DomainStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The domain status.
      See Also:

    • customDomainConfig

      public final CustomDomainConfigType customDomainConfig()

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

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

    • toBuilder

      public DomainDescriptionType.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<DomainDescriptionType.Builder,DomainDescriptionType>
      Returns:
      a builder for type T

    • builder

      public static DomainDescriptionType.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.