Class DomainDescriptionType
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DomainDescriptionType.Builder,
DomainDescriptionType>
A container for information about a domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Web Services ID for the user pool owner.builder()
final String
The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.final CustomDomainConfigType
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.final String
domain()
The domain string.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
s3Bucket()
The Amazon S3 bucket where the static files for this domain are stored.static Class
<? extends DomainDescriptionType.Builder> final DomainStatusType
status()
The domain status.final String
The domain status.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The user pool ID.final String
version()
The app version.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
userPoolId
The user pool ID.
- Returns:
- The user pool ID.
-
awsAccountId
The Amazon Web Services ID for the user pool owner.
- Returns:
- The Amazon Web Services ID for the user pool owner.
-
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 asauth
.- 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 asauth
.
-
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
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
The app version.
- Returns:
- The app version.
-
status
The domain status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDomainStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The domain status.
- See Also:
-
statusAsString
The domain status.
If the service returns an enum value that is not available in the current SDK version,
status
will returnDomainStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The domain status.
- See Also:
-
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
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 interfaceToCopyableBuilder<DomainDescriptionType.Builder,
DomainDescriptionType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-