DomainDescriptionType (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.services.cognitoidentityprovider.model.DomainDescriptionType

All Implemented Interfaces:

java.io.Serializable
```
public class DomainDescriptionType
extends java.lang.Object
implements java.io.Serializable
```
A container for information about a domain.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DomainDescriptionType()

Constructors
Constructor and Description
`DomainDescriptionType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAWSAccountId()` The Amazon Web Services ID for the user pool owner.
`java.lang.String`	`getCloudFrontDistribution()` 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`	`getCustomDomainConfig()` The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
`java.lang.String`	`getDomain()` The domain string.
`java.lang.String`	`getS3Bucket()` The Amazon S3 bucket where the static files for this domain are stored.
`java.lang.String`	`getStatus()` The domain status.
`java.lang.String`	`getUserPoolId()` The user pool ID.
`java.lang.String`	`getVersion()` The app version.
`int`	`hashCode()`
`void`	`setAWSAccountId(java.lang.String aWSAccountId)` The Amazon Web Services ID for the user pool owner.
`void`	`setCloudFrontDistribution(java.lang.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.
`void`	`setCustomDomainConfig(CustomDomainConfigType customDomainConfig)` The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
`void`	`setDomain(java.lang.String domain)` The domain string.
`void`	`setS3Bucket(java.lang.String s3Bucket)` The Amazon S3 bucket where the static files for this domain are stored.
`void`	`setStatus(DomainStatusType status)` The domain status.
`void`	`setStatus(java.lang.String status)` The domain status.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID.
`void`	`setVersion(java.lang.String version)` The app version.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DomainDescriptionType`	`withAWSAccountId(java.lang.String aWSAccountId)` The Amazon Web Services ID for the user pool owner.
`DomainDescriptionType`	`withCloudFrontDistribution(java.lang.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.
`DomainDescriptionType`	`withCustomDomainConfig(CustomDomainConfigType customDomainConfig)` The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
`DomainDescriptionType`	`withDomain(java.lang.String domain)` The domain string.
`DomainDescriptionType`	`withS3Bucket(java.lang.String s3Bucket)` The Amazon S3 bucket where the static files for this domain are stored.
`DomainDescriptionType`	`withStatus(DomainStatusType status)` The domain status.
`DomainDescriptionType`	`withStatus(java.lang.String status)` The domain status.
`DomainDescriptionType`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID.
`DomainDescriptionType`	`withVersion(java.lang.String version)` The app version.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DomainDescriptionType
```
public DomainDescriptionType()
```
- Method Detail
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
  - withUserPoolId
```
public DomainDescriptionType withUserPoolId(java.lang.String userPoolId)
```
    The user pool ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAWSAccountId
```
public java.lang.String getAWSAccountId()
```
    The Amazon Web Services ID for the user pool owner.
    
    Constraints:
    Length: - 12
    Pattern: [0-9]+
    
    Returns:
    
    The Amazon Web Services ID for the user pool owner.
  - setAWSAccountId
```
public void setAWSAccountId(java.lang.String aWSAccountId)
```
    The Amazon Web Services ID for the user pool owner.
    
    Constraints:
    Length: - 12
    Pattern: [0-9]+
    
    Parameters:
    
    aWSAccountId -
    The Amazon Web Services ID for the user pool owner.
  - withAWSAccountId
```
public DomainDescriptionType withAWSAccountId(java.lang.String aWSAccountId)
```
    The Amazon Web Services ID for the user pool owner.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 12
    Pattern: [0-9]+
    
    Parameters:
    
    aWSAccountId -
    The Amazon Web Services ID for the user pool owner.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDomain
```
public java.lang.String getDomain()
```
    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.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    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.
  - setDomain
```
public void setDomain(java.lang.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.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Parameters:
    
    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.
  - withDomain
```
public DomainDescriptionType withDomain(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getS3Bucket
```
public java.lang.String getS3Bucket()
```
    The Amazon S3 bucket where the static files for this domain are stored.
    
    Constraints:
    Length: 3 - 1024
    Pattern: ^[0-9A-Za-z\.\-_]*(?
    
    Returns:
    
    The Amazon S3 bucket where the static files for this domain are stored.
  - setS3Bucket
```
public void setS3Bucket(java.lang.String s3Bucket)
```
    The Amazon S3 bucket where the static files for this domain are stored.
    
    Constraints:
    Length: 3 - 1024
    Pattern: ^[0-9A-Za-z\.\-_]*(?
    
    Parameters:
    
    s3Bucket -
    The Amazon S3 bucket where the static files for this domain are stored.
  - withS3Bucket
```
public DomainDescriptionType withS3Bucket(java.lang.String s3Bucket)
```
    The Amazon S3 bucket where the static files for this domain are stored.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 3 - 1024
    Pattern: ^[0-9A-Za-z\.\-_]*(?
    
    Parameters:
    
    s3Bucket -
    The Amazon S3 bucket where the static files for this domain are stored.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCloudFrontDistribution
```
public java.lang.String getCloudFrontDistribution()
```
    The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
    
    Constraints:
    Length: 0 - 131072
    
    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.
  - setCloudFrontDistribution
```
public void setCloudFrontDistribution(java.lang.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.
    
    Constraints:
    Length: 0 - 131072
    
    Parameters:
    
    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.
  - withCloudFrontDistribution
```
public DomainDescriptionType withCloudFrontDistribution(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 131072
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getVersion
```
public java.lang.String getVersion()
```
    The app version.
    
    Constraints:
    Length: 1 - 20
    
    Returns:
    
    The app version.
  - setVersion
```
public void setVersion(java.lang.String version)
```
    The app version.
    
    Constraints:
    Length: 1 - 20
    
    Parameters:
    
    version -
    The app version.
  - withVersion
```
public DomainDescriptionType withVersion(java.lang.String version)
```
    The app version.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 20
    
    Parameters:
    
    version -
    The app version.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getStatus
```
public java.lang.String getStatus()
```
    The domain status.
    
    Constraints:
    Allowed Values: CREATING, DELETING, UPDATING, ACTIVE, FAILED
    
    Returns:
    
    The domain status.
    
    See Also:
    
    DomainStatusType
  - setStatus
```
public void setStatus(java.lang.String status)
```
    The domain status.
    
    Constraints:
    Allowed Values: CREATING, DELETING, UPDATING, ACTIVE, FAILED
    
    Parameters:
    
    status -
    The domain status.
    
    See Also:
    
    DomainStatusType
  - withStatus
```
public DomainDescriptionType withStatus(java.lang.String status)
```
    The domain status.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATING, DELETING, UPDATING, ACTIVE, FAILED
    
    Parameters:
    
    status -
    The domain status.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DomainStatusType
  - setStatus
```
public void setStatus(DomainStatusType status)
```
    The domain status.
    
    Constraints:
    Allowed Values: CREATING, DELETING, UPDATING, ACTIVE, FAILED
    
    Parameters:
    
    status -
    The domain status.
    
    See Also:
    
    DomainStatusType
  - withStatus
```
public DomainDescriptionType withStatus(DomainStatusType status)
```
    The domain status.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: CREATING, DELETING, UPDATING, ACTIVE, FAILED
    
    Parameters:
    
    status -
    The domain status.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    DomainStatusType
  - getCustomDomainConfig
```
public CustomDomainConfigType getCustomDomainConfig()
```
    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.
  - setCustomDomainConfig
```
public void setCustomDomainConfig(CustomDomainConfigType customDomainConfig)
```
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Parameters:
    
    customDomainConfig -
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
  - withCustomDomainConfig
```
public DomainDescriptionType withCustomDomainConfig(CustomDomainConfigType customDomainConfig)
```
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    customDomainConfig -
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class DomainDescriptionType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainDescriptionType

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getAWSAccountId

setAWSAccountId

withAWSAccountId

getDomain

setDomain

withDomain

getS3Bucket

setS3Bucket

withS3Bucket

getCloudFrontDistribution

setCloudFrontDistribution

withCloudFrontDistribution

getVersion

setVersion

withVersion

getStatus

setStatus

withStatus

setStatus

withStatus

getCustomDomainConfig

setCustomDomainConfig

withCustomDomainConfig

toString

hashCode

equals