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

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.CreateUserPoolDomainRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class CreateUserPoolDomainRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Creates a new domain for a user pool.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more
- Signing Amazon Web Services API Requests
- Using the Amazon Cognito user pools API and user pool endpoints
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateUserPoolDomainRequest()

Constructors
Constructor and Description
`CreateUserPoolDomainRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`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`	`getUserPoolId()` The user pool ID.
`int`	`hashCode()`
`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`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateUserPoolDomainRequest`	`withCustomDomainConfig(CustomDomainConfigType customDomainConfig)` The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
`CreateUserPoolDomainRequest`	`withDomain(java.lang.String domain)` The domain string.
`CreateUserPoolDomainRequest`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - CreateUserPoolDomainRequest
```
public CreateUserPoolDomainRequest()
```
- Method Detail
  - 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 CreateUserPoolDomainRequest 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.
  - 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 CreateUserPoolDomainRequest 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.
  - getCustomDomainConfig
```
public CustomDomainConfigType getCustomDomainConfig()
```
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
    
    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
    
    Returns:
    
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
    
    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
  - setCustomDomainConfig
```
public void setCustomDomainConfig(CustomDomainConfigType customDomainConfig)
```
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
    
    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
    
    Parameters:
    
    customDomainConfig -
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
    
    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
  - withCustomDomainConfig
```
public CreateUserPoolDomainRequest withCustomDomainConfig(CustomDomainConfigType customDomainConfig)
```
    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
    
    Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
    
    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
    
    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.
    
    Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.
    
    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
    
    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 CreateUserPoolDomainRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateUserPoolDomainRequest

Method Detail

getDomain

setDomain

withDomain

getUserPoolId

setUserPoolId

withUserPoolId

getCustomDomainConfig

setCustomDomainConfig

withCustomDomainConfig

toString

hashCode

equals