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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class UpdateUserPoolDomainRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.

You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You can't use it to change the domain for a user pool.

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.

Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.

However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.

When you add your new certificate in ACM, you must choose US East (N. Virginia) as the Amazon Web Services Region.

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
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

UpdateUserPoolDomainRequest()

Constructors
Constructor and Description
`UpdateUserPoolDomainRequest()`

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 pages for your application.
`java.lang.String`	`getDomain()` The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.
`java.lang.String`	`getUserPoolId()` The ID of the user pool that is associated with the custom domain whose certificate you're updating.
`int`	`hashCode()`
`void`	`setCustomDomainConfig(CustomDomainConfigType customDomainConfig)` The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
`void`	`setDomain(java.lang.String domain)` The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.
`void`	`setUserPoolId(java.lang.String userPoolId)` The ID of the user pool that is associated with the custom domain whose certificate you're updating.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateUserPoolDomainRequest`	`withCustomDomainConfig(CustomDomainConfigType customDomainConfig)` The configuration for a custom domain that hosts the sign-up and sign-in pages for your application.
`UpdateUserPoolDomainRequest`	`withDomain(java.lang.String domain)` The domain name for the custom domain that hosts the sign-up and sign-in pages for your application.
`UpdateUserPoolDomainRequest`	`withUserPoolId(java.lang.String userPoolId)` The ID of the user pool that is associated with the custom domain whose certificate you're updating.

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
  - UpdateUserPoolDomainRequest
```
public UpdateUserPoolDomainRequest()
```
- Method Detail
  - getDomain
```
public java.lang.String getDomain()
```
    The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
    
    This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Returns:
    
    The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
    
    This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
    
    This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
    
    Constraints:
    Length: 1 - 63
    Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$
    
    Parameters:
    
    domain -
    The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
    
    This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
  - withDomain
```
public UpdateUserPoolDomainRequest withDomain(java.lang.String domain)
```
    The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
    
    This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
    
    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 name for the custom domain that hosts the sign-up and sign-in pages for your application. One example might be auth.example.com.
    
    This string can include only lowercase letters, numbers, and hyphens. Don't use a hyphen for the first or last character. Use periods to separate subdomain names.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The ID of the user pool that is associated with the custom domain whose certificate you're updating.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The ID of the user pool that is associated with the custom domain whose certificate you're updating.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The ID of the user pool that is associated with the custom domain whose certificate you're updating.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The ID of the user pool that is associated with the custom domain whose certificate you're updating.
  - withUserPoolId
```
public UpdateUserPoolDomainRequest withUserPoolId(java.lang.String userPoolId)
```
    The ID of the user pool that is associated with the custom domain whose certificate you're updating.
    
    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 ID of the user pool that is associated with the custom domain whose certificate you're updating.
    
    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 pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
    
    Returns:
    
    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
  - setCustomDomainConfig
```
public void setCustomDomainConfig(CustomDomainConfigType customDomainConfig)
```
    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
    
    Parameters:
    
    customDomainConfig -
    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
  - withCustomDomainConfig
```
public UpdateUserPoolDomainRequest withCustomDomainConfig(CustomDomainConfigType customDomainConfig)
```
    The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
    
    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 pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
    
    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 UpdateUserPoolDomainRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateUserPoolDomainRequest

Method Detail

getDomain

setDomain

withDomain

getUserPoolId

setUserPoolId

withUserPoolId

getCustomDomainConfig

setCustomDomainConfig

withCustomDomainConfig

toString

hashCode

equals