UserPoolClientType (AWS SDK for Android - Amazon Cognito Identity Provider 2.13.4 API)

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

All Implemented Interfaces:

Serializable
```
public class UserPoolClientType
extends Object
implements Serializable
```
Contains information about a user pool client.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserPoolClientType()

Constructors
Constructor and Description
`UserPoolClientType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<String>`	`getAllowedOAuthFlows()` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`Boolean`	`getAllowedOAuthFlowsUserPoolClient()` Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`List<String>`	`getAllowedOAuthScopes()` A list of allowed `OAuth` scopes.
`AnalyticsConfigurationType`	`getAnalyticsConfiguration()` The Amazon Pinpoint analytics configuration for the user pool client.
`List<String>`	`getCallbackURLs()` A list of allowed redirect (callback) URLs for the identity providers.
`String`	`getClientId()` The ID of the client associated with the user pool.
`String`	`getClientName()` The client name from the user pool request of the client type.
`String`	`getClientSecret()` The client secret from the user pool request of the client type.
`Date`	`getCreationDate()` The date the user pool client was created.
`String`	`getDefaultRedirectURI()` The default redirect URI.
`List<String>`	`getExplicitAuthFlows()` The explicit authentication flows.
`Date`	`getLastModifiedDate()` The date the user pool client was last modified.
`List<String>`	`getLogoutURLs()` A list of allowed logout URLs for the identity providers.
`List<String>`	`getReadAttributes()` The Read-only attributes.
`Integer`	`getRefreshTokenValidity()` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`List<String>`	`getSupportedIdentityProviders()` A list of provider names for the identity providers that are supported on this client.
`String`	`getUserPoolId()` The user pool ID for the user pool client.
`List<String>`	`getWriteAttributes()` The writeable attributes.
`int`	`hashCode()`
`Boolean`	`isAllowedOAuthFlowsUserPoolClient()` Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`void`	`setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`void`	`setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`void`	`setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` A list of allowed `OAuth` scopes.
`void`	`setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`void`	`setCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`void`	`setClientId(String clientId)` The ID of the client associated with the user pool.
`void`	`setClientName(String clientName)` The client name from the user pool request of the client type.
`void`	`setClientSecret(String clientSecret)` The client secret from the user pool request of the client type.
`void`	`setCreationDate(Date creationDate)` The date the user pool client was created.
`void`	`setDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`void`	`setExplicitAuthFlows(Collection<String> explicitAuthFlows)` The explicit authentication flows.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The date the user pool client was last modified.
`void`	`setLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`void`	`setReadAttributes(Collection<String> readAttributes)` The Read-only attributes.
`void`	`setRefreshTokenValidity(Integer refreshTokenValidity)` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`void`	`setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool client.
`void`	`setWriteAttributes(Collection<String> writeAttributes)` The writeable attributes.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UserPoolClientType`	`withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`UserPoolClientType`	`withAllowedOAuthFlows(String... allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`UserPoolClientType`	`withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`UserPoolClientType`	`withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` A list of allowed `OAuth` scopes.
`UserPoolClientType`	`withAllowedOAuthScopes(String... allowedOAuthScopes)` A list of allowed `OAuth` scopes.
`UserPoolClientType`	`withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`UserPoolClientType`	`withCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`UserPoolClientType`	`withCallbackURLs(String... callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`UserPoolClientType`	`withClientId(String clientId)` The ID of the client associated with the user pool.
`UserPoolClientType`	`withClientName(String clientName)` The client name from the user pool request of the client type.
`UserPoolClientType`	`withClientSecret(String clientSecret)` The client secret from the user pool request of the client type.
`UserPoolClientType`	`withCreationDate(Date creationDate)` The date the user pool client was created.
`UserPoolClientType`	`withDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`UserPoolClientType`	`withExplicitAuthFlows(Collection<String> explicitAuthFlows)` The explicit authentication flows.
`UserPoolClientType`	`withExplicitAuthFlows(String... explicitAuthFlows)` The explicit authentication flows.
`UserPoolClientType`	`withLastModifiedDate(Date lastModifiedDate)` The date the user pool client was last modified.
`UserPoolClientType`	`withLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`UserPoolClientType`	`withLogoutURLs(String... logoutURLs)` A list of allowed logout URLs for the identity providers.
`UserPoolClientType`	`withReadAttributes(Collection<String> readAttributes)` The Read-only attributes.
`UserPoolClientType`	`withReadAttributes(String... readAttributes)` The Read-only attributes.
`UserPoolClientType`	`withRefreshTokenValidity(Integer refreshTokenValidity)` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`UserPoolClientType`	`withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`UserPoolClientType`	`withSupportedIdentityProviders(String... supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`UserPoolClientType`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool client.
`UserPoolClientType`	`withWriteAttributes(Collection<String> writeAttributes)` The writeable attributes.
`UserPoolClientType`	`withWriteAttributes(String... writeAttributes)` The writeable attributes.

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

- Constructor Detail
  - UserPoolClientType
```
public UserPoolClientType()
```
- Method Detail
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool client.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID for the user pool client.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool client.
  - withUserPoolId
```
public UserPoolClientType withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    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 for the user pool client.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientName
```
public String getClientName()
```
    The client name from the user pool request of the client type.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Returns:
    
    The client name from the user pool request of the client type.
  - setClientName
```
public void setClientName(String clientName)
```
    The client name from the user pool request of the client type.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Parameters:
    
    clientName -
    The client name from the user pool request of the client type.
  - withClientName
```
public UserPoolClientType withClientName(String clientName)
```
    The client name from the user pool request of the client type.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Parameters:
    
    clientName -
    The client name from the user pool request of the client type.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The ID of the client associated with the user pool.
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
  - withClientId
```
public UserPoolClientType withClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientSecret
```
public String getClientSecret()
```
    The client secret from the user pool request of the client type.
    
    Constraints:
    Length: 1 - 64
    Pattern: [\w+]+
    
    Returns:
    
    The client secret from the user pool request of the client type.
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    The client secret from the user pool request of the client type.
    
    Constraints:
    Length: 1 - 64
    Pattern: [\w+]+
    
    Parameters:
    
    clientSecret -
    The client secret from the user pool request of the client type.
  - withClientSecret
```
public UserPoolClientType withClientSecret(String clientSecret)
```
    The client secret from the user pool request of the client type.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 64
    Pattern: [\w+]+
    
    Parameters:
    
    clientSecret -
    The client secret from the user pool request of the client type.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the user pool client was last modified.
    
    Returns:
    
    The date the user pool client was last modified.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool client was last modified.
    
    Parameters:
    
    lastModifiedDate -
    The date the user pool client was last modified.
  - withLastModifiedDate
```
public UserPoolClientType withLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool client was last modified.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    lastModifiedDate -
    The date the user pool client was last modified.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the user pool client was created.
    
    Returns:
    
    The date the user pool client was created.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the user pool client was created.
    
    Parameters:
    
    creationDate -
    The date the user pool client was created.
  - withCreationDate
```
public UserPoolClientType withCreationDate(Date creationDate)
```
    The date the user pool client was created.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    creationDate -
    The date the user pool client was created.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRefreshTokenValidity
```
public Integer getRefreshTokenValidity()
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Constraints:
    Range: 0 - 3650
    
    Returns:
    
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - setRefreshTokenValidity
```
public void setRefreshTokenValidity(Integer refreshTokenValidity)
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Constraints:
    Range: 0 - 3650
    
    Parameters:
    
    refreshTokenValidity -
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - withRefreshTokenValidity
```
public UserPoolClientType withRefreshTokenValidity(Integer refreshTokenValidity)
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 - 3650
    
    Parameters:
    
    refreshTokenValidity -
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getReadAttributes
```
public List<String> getReadAttributes()
```
    The Read-only attributes.
    
    Returns:
    
    The Read-only attributes.
  - setReadAttributes
```
public void setReadAttributes(Collection<String> readAttributes)
```
    The Read-only attributes.
    
    Parameters:
    
    readAttributes -
    The Read-only attributes.
  - withReadAttributes
```
public UserPoolClientType withReadAttributes(String... readAttributes)
```
    The Read-only attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    readAttributes -
    The Read-only attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withReadAttributes
```
public UserPoolClientType withReadAttributes(Collection<String> readAttributes)
```
    The Read-only attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    readAttributes -
    The Read-only attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getWriteAttributes
```
public List<String> getWriteAttributes()
```
    The writeable attributes.
    
    Returns:
    
    The writeable attributes.
  - setWriteAttributes
```
public void setWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes.
    
    Parameters:
    
    writeAttributes -
    The writeable attributes.
  - withWriteAttributes
```
public UserPoolClientType withWriteAttributes(String... writeAttributes)
```
    The writeable attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    writeAttributes -
    The writeable attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withWriteAttributes
```
public UserPoolClientType withWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    writeAttributes -
    The writeable attributes.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExplicitAuthFlows
```
public List<String> getExplicitAuthFlows()
```
    The explicit authentication flows.
    
    Returns:
    
    The explicit authentication flows.
  - setExplicitAuthFlows
```
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    The explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows -
    The explicit authentication flows.
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(String... explicitAuthFlows)
```
    The explicit authentication flows.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    explicitAuthFlows -
    The explicit authentication flows.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    The explicit authentication flows.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    explicitAuthFlows -
    The explicit authentication flows.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSupportedIdentityProviders
```
public List<String> getSupportedIdentityProviders()
```
    A list of provider names for the identity providers that are supported on this client.
    
    Returns:
    
    A list of provider names for the identity providers that are supported on this client.
  - setSupportedIdentityProviders
```
public void setSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
```
    A list of provider names for the identity providers that are supported on this client.
    
    Parameters:
    
    supportedIdentityProviders -
    A list of provider names for the identity providers that are supported on this client.
  - withSupportedIdentityProviders
```
public UserPoolClientType withSupportedIdentityProviders(String... supportedIdentityProviders)
```
    A list of provider names for the identity providers that are supported on this client.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    supportedIdentityProviders -
    A list of provider names for the identity providers that are supported on this client.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withSupportedIdentityProviders
```
public UserPoolClientType withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)
```
    A list of provider names for the identity providers that are supported on this client.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    supportedIdentityProviders -
    A list of provider names for the identity providers that are supported on this client.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCallbackURLs
```
public List<String> getCallbackURLs()
```
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    Returns:
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    
    Be an absolute URI.
    
    Be registered with the authorization server.
    
    Not include a fragment component.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
  - setCallbackURLs
```
public void setCallbackURLs(Collection<String> callbackURLs)
```
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    Parameters:
    callbackURLs -
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    
    Be an absolute URI.
    
    Be registered with the authorization server.
    
    Not include a fragment component.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
  - withCallbackURLs
```
public UserPoolClientType withCallbackURLs(String... callbackURLs)
```
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    callbackURLs -
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    
    Be an absolute URI.
    
    Be registered with the authorization server.
    
    Not include a fragment component.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withCallbackURLs
```
public UserPoolClientType withCallbackURLs(Collection<String> callbackURLs)
```
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    
    Returns a reference to this object so that method calls can be chained together.
    Parameters:
    callbackURLs -
    A list of allowed redirect (callback) URLs for the identity providers.
    
    A redirect URI must:
    
    Be an absolute URI.
    
    Be registered with the authorization server.
    
    Not include a fragment component.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLogoutURLs
```
public List<String> getLogoutURLs()
```
    A list of allowed logout URLs for the identity providers.
    
    Returns:
    
    A list of allowed logout URLs for the identity providers.
  - setLogoutURLs
```
public void setLogoutURLs(Collection<String> logoutURLs)
```
    A list of allowed logout URLs for the identity providers.
    
    Parameters:
    
    logoutURLs -
    A list of allowed logout URLs for the identity providers.
  - withLogoutURLs
```
public UserPoolClientType withLogoutURLs(String... logoutURLs)
```
    A list of allowed logout URLs for the identity providers.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    logoutURLs -
    A list of allowed logout URLs for the identity providers.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withLogoutURLs
```
public UserPoolClientType withLogoutURLs(Collection<String> logoutURLs)
```
    A list of allowed logout URLs for the identity providers.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    logoutURLs -
    A list of allowed logout URLs for the identity providers.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getDefaultRedirectURI
```
public String getDefaultRedirectURI()
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    
    Constraints:
    Length: 1 - 1024
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    Returns:
    The default redirect URI. Must be in the CallbackURLs list.
    
    A redirect URI must:
    
    Be an absolute URI.
    
    Be registered with the authorization server.
    
    Not include a fragment component.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
  - setDefaultRedirectURI
```
public void setDefaultRedirectURI(String defaultRedirectURI)
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    
    Constraints:
    Length: 1 - 1024
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    Parameters:
    defaultRedirectURI -
    The default redirect URI. Must be in the CallbackURLs list.
    
    A redirect URI must:
    
    Be an absolute URI.
    
    Be registered with the authorization server.
    
    Not include a fragment component.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
  - withDefaultRedirectURI
```
public UserPoolClientType withDefaultRedirectURI(String defaultRedirectURI)
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    A redirect URI must:
    - Be an absolute URI.
    - Be registered with the authorization server.
    - Not include a fragment component.
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 1024
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    Parameters:
    defaultRedirectURI -
    The default redirect URI. Must be in the CallbackURLs list.
    
    A redirect URI must:
    
    Be an absolute URI.
    
    Be registered with the authorization server.
    
    Not include a fragment component.
    
    See OAuth 2.0 - Redirection Endpoint.
    
    Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
    
    App callback URLs such as myapp://example are also supported.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAllowedOAuthFlows
```
public List<String> getAllowedOAuthFlows()
```
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Returns:
    
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
  - setAllowedOAuthFlows
```
public void setAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
```
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Parameters:
    
    allowedOAuthFlows -
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
  - withAllowedOAuthFlows
```
public UserPoolClientType withAllowedOAuthFlows(String... allowedOAuthFlows)
```
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowedOAuthFlows -
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAllowedOAuthFlows
```
public UserPoolClientType withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)
```
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowedOAuthFlows -
    Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
    
    Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAllowedOAuthScopes
```
public List<String> getAllowedOAuthScopes()
```
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Returns:
    
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
  - setAllowedOAuthScopes
```
public void setAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
```
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Parameters:
    
    allowedOAuthScopes -
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
  - withAllowedOAuthScopes
```
public UserPoolClientType withAllowedOAuthScopes(String... allowedOAuthScopes)
```
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowedOAuthScopes -
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withAllowedOAuthScopes
```
public UserPoolClientType withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)
```
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowedOAuthScopes -
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isAllowedOAuthFlowsUserPoolClient
```
public Boolean isAllowedOAuthFlowsUserPoolClient()
```
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - getAllowedOAuthFlowsUserPoolClient
```
public Boolean getAllowedOAuthFlowsUserPoolClient()
```
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - setAllowedOAuthFlowsUserPoolClient
```
public void setAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
```
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Parameters:
    
    allowedOAuthFlowsUserPoolClient -
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
  - withAllowedOAuthFlowsUserPoolClient
```
public UserPoolClientType withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
```
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    allowedOAuthFlowsUserPoolClient -
    Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getAnalyticsConfiguration
```
public AnalyticsConfigurationType getAnalyticsConfiguration()
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Returns:
    
    The Amazon Pinpoint analytics configuration for the user pool client.
  - setAnalyticsConfiguration
```
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Parameters:
    
    analyticsConfiguration -
    The Amazon Pinpoint analytics configuration for the user pool client.
  - withAnalyticsConfiguration
```
public UserPoolClientType withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    analyticsConfiguration -
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class UserPoolClientType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPoolClientType

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getClientName

setClientName

withClientName

getClientId

setClientId

withClientId

getClientSecret

setClientSecret

withClientSecret

getLastModifiedDate

setLastModifiedDate

withLastModifiedDate

getCreationDate

setCreationDate

withCreationDate

getRefreshTokenValidity

setRefreshTokenValidity

withRefreshTokenValidity

getReadAttributes

setReadAttributes

withReadAttributes

withReadAttributes

getWriteAttributes

setWriteAttributes

withWriteAttributes

withWriteAttributes

getExplicitAuthFlows

setExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

getSupportedIdentityProviders

setSupportedIdentityProviders

withSupportedIdentityProviders

withSupportedIdentityProviders

getCallbackURLs

setCallbackURLs

withCallbackURLs

withCallbackURLs

getLogoutURLs

setLogoutURLs

withLogoutURLs

withLogoutURLs

getDefaultRedirectURI

setDefaultRedirectURI

withDefaultRedirectURI

getAllowedOAuthFlows

setAllowedOAuthFlows

withAllowedOAuthFlows

withAllowedOAuthFlows

getAllowedOAuthScopes

setAllowedOAuthScopes

withAllowedOAuthScopes

withAllowedOAuthScopes

isAllowedOAuthFlowsUserPoolClient

getAllowedOAuthFlowsUserPoolClient

setAllowedOAuthFlowsUserPoolClient

withAllowedOAuthFlowsUserPoolClient

getAnalyticsConfiguration

setAnalyticsConfiguration

withAnalyticsConfiguration

toString

hashCode

equals