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 the user pool domain associated with the hosted UI and OAuth endpoints.

See Also:

  • Method Details

    • userPoolId

      public final String userPoolId()

      The ID of the user pool that the domain is attached to.

      Returns:
      The ID of the user pool that the domain is attached to.

    • awsAccountId

      public final String awsAccountId()

      The Amazon Web Services account that you created the user pool in.

      Returns:
      The Amazon Web Services account that you created the user pool in.

    • 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 hosts your custom domain.

      Returns:
      The Amazon CloudFront endpoint that hosts your custom domain.

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

    • 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) branding and a version of 2 indicates managed login branding.

      Managed login requires that your user pool be configured for any feature plan other than Lite.

      Returns:
      The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) branding and a version of 2 indicates managed login branding.

      Managed login requires that your user pool be configured for any feature plan other than Lite.

    • routing

      public final RoutingType routing()

      The routing configuration for the domain, including failover settings for multi-region deployments. Currently only Failover configurations are allowed.

      Returns:
      The routing configuration for the domain, including failover settings for multi-region deployments. Currently only Failover configurations are allowed.

    • toBuilder

      public DomainDescriptionType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DomainDescriptionType.Builder,DomainDescriptionType>

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

    • 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