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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DomainDescriptionType.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
awsAccountId()
The Amazon Web Services ID for the user pool owner.static DomainDescriptionType.Builder
builder()
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.CustomDomainConfigType
customDomainConfig()
The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.String
domain()
The domain string.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
s3Bucket()
The Amazon S3 bucket where the static files for this domain are stored.List<SdkField<?>>
sdkFields()
static Class<? extends DomainDescriptionType.Builder>
serializableBuilderClass()
DomainStatusType
status()
The domain status.String
statusAsString()
The domain status.DomainDescriptionType.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
userPoolId()
The user pool ID.String
version()
The app version.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 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
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 returnDomainStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The domain status.
- See Also:
DomainStatusType
-
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 returnDomainStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The domain status.
- See Also:
DomainStatusType
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DomainDescriptionType.Builder,DomainDescriptionType>
-
builder
public static DomainDescriptionType.Builder builder()
-
serializableBuilderClass
public static Class<? extends DomainDescriptionType.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-