DomainDescriptionType (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DomainDescriptionType
extends Object
implements Serializable, Cloneable, StructuredPojo

A container for information about a domain.

See Also:: AWS API Documentation, 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
`DomainDescriptionType`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAWSAccountId()` The Amazon Web Services ID for the user pool owner.
`String`	`getCloudFrontDistribution()` The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
`CustomDomainConfigType`	`getCustomDomainConfig()` The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
`String`	`getDomain()` The domain string.
`String`	`getS3Bucket()` The Amazon S3 bucket where the static files for this domain are stored.
`String`	`getStatus()` The domain status.
`String`	`getUserPoolId()` The user pool ID.
`String`	`getVersion()` The app version.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAWSAccountId(String aWSAccountId)` The Amazon Web Services ID for the user pool owner.
`void`	`setCloudFrontDistribution(String cloudFrontDistribution)` The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
`void`	`setCustomDomainConfig(CustomDomainConfigType customDomainConfig)` The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
`void`	`setDomain(String domain)` The domain string.
`void`	`setS3Bucket(String s3Bucket)` The Amazon S3 bucket where the static files for this domain are stored.
`void`	`setStatus(DomainStatusType status)` The domain status.
`void`	`setStatus(String status)` The domain status.
`void`	`setUserPoolId(String userPoolId)` The user pool ID.
`void`	`setVersion(String version)` The app version.
`String`	`toString()` Returns a string representation of this object.
`DomainDescriptionType`	`withAWSAccountId(String aWSAccountId)` The Amazon Web Services ID for the user pool owner.
`DomainDescriptionType`	`withCloudFrontDistribution(String cloudFrontDistribution)` The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
`DomainDescriptionType`	`withCustomDomainConfig(CustomDomainConfigType customDomainConfig)` The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
`DomainDescriptionType`	`withDomain(String domain)` The domain string.
`DomainDescriptionType`	`withS3Bucket(String s3Bucket)` The Amazon S3 bucket where the static files for this domain are stored.
`DomainDescriptionType`	`withStatus(DomainStatusType status)` The domain status.
`DomainDescriptionType`	`withStatus(String status)` The domain status.
`DomainDescriptionType`	`withUserPoolId(String userPoolId)` The user pool ID.
`DomainDescriptionType`	`withVersion(String version)` The app version.

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

- Constructor Detail
  - DomainDescriptionType
```
public DomainDescriptionType()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID.
    
    Parameters:
    
    userPoolId - The user pool ID.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID.
    
    Returns:
    
    The user pool ID.
  - withUserPoolId
```
public DomainDescriptionType withUserPoolId(String userPoolId)
```
    The user pool ID.
    
    Parameters:
    
    userPoolId - The user pool ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAWSAccountId
```
public void setAWSAccountId(String aWSAccountId)
```
    The Amazon Web Services ID for the user pool owner.
    
    Parameters:
    
    aWSAccountId - The Amazon Web Services ID for the user pool owner.
  - getAWSAccountId
```
public String getAWSAccountId()
```
    The Amazon Web Services ID for the user pool owner.
    
    Returns:
    
    The Amazon Web Services ID for the user pool owner.
  - withAWSAccountId
```
public DomainDescriptionType withAWSAccountId(String aWSAccountId)
```
    The Amazon Web Services ID for the user pool owner.
    
    Parameters:
    
    aWSAccountId - The Amazon Web Services ID for the user pool owner.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDomain
```
public void setDomain(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.
    
    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.
  - getDomain
```
public 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.
    
    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.
  - withDomain
```
public DomainDescriptionType withDomain(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3Bucket
```
public void setS3Bucket(String s3Bucket)
```
    The Amazon S3 bucket where the static files for this domain are stored.
    
    Parameters:
    
    s3Bucket - The Amazon S3 bucket where the static files for this domain are stored.
  - getS3Bucket
```
public String getS3Bucket()
```
    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.
  - withS3Bucket
```
public DomainDescriptionType withS3Bucket(String s3Bucket)
```
    The Amazon S3 bucket where the static files for this domain are stored.
    
    Parameters:
    
    s3Bucket - The Amazon S3 bucket where the static files for this domain are stored.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudFrontDistribution
```
public void setCloudFrontDistribution(String cloudFrontDistribution)
```
    The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
    
    Parameters:
    
    cloudFrontDistribution - The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
  - getCloudFrontDistribution
```
public String getCloudFrontDistribution()
```
    The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
  - withCloudFrontDistribution
```
public DomainDescriptionType withCloudFrontDistribution(String cloudFrontDistribution)
```
    The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
    
    Parameters:
    
    cloudFrontDistribution - The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The app version.
    
    Parameters:
    
    version - The app version.
  - getVersion
```
public String getVersion()
```
    The app version.
    
    Returns:
    
    The app version.
  - withVersion
```
public DomainDescriptionType withVersion(String version)
```
    The app version.
    
    Parameters:
    
    version - The app version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The domain status.
    
    Parameters:
    
    status - The domain status.
    
    See Also:
    
    DomainStatusType
  - getStatus
```
public String getStatus()
```
    The domain status.
    
    Returns:
    
    The domain status.
    
    See Also:
    
    DomainStatusType
  - withStatus
```
public DomainDescriptionType withStatus(String status)
```
    The domain status.
    
    Parameters:
    
    status - The domain status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DomainStatusType
  - setStatus
```
public void setStatus(DomainStatusType status)
```
    The domain status.
    
    Parameters:
    
    status - The domain status.
    
    See Also:
    
    DomainStatusType
  - withStatus
```
public DomainDescriptionType withStatus(DomainStatusType status)
```
    The domain status.
    
    Parameters:
    
    status - The domain status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DomainStatusType
  - 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.
  - 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.
  - withCustomDomainConfig
```
public DomainDescriptionType withCustomDomainConfig(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DomainDescriptionType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DomainDescriptionType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DomainDescriptionType

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setAWSAccountId

getAWSAccountId

withAWSAccountId

setDomain

getDomain

withDomain

setS3Bucket

getS3Bucket

withS3Bucket

setCloudFrontDistribution

getCloudFrontDistribution

withCloudFrontDistribution

setVersion

getVersion

withVersion

setStatus

getStatus

withStatus

setStatus

withStatus

setCustomDomainConfig

getCustomDomainConfig

withCustomDomainConfig

toString

equals

hashCode

clone

marshall