UpdateUserPoolClientRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidp.model.UpdateUserPoolClientRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateUserPoolClientRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the request to update the user pool client.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateUserPoolClientRequest()

Constructors
Constructor and Description
`UpdateUserPoolClientRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateUserPoolClientRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`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.
`List<String>`	`getCallbackURLs()` A list of allowed 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 update user pool client request.
`String`	`getDefaultRedirectURI()` The default redirect URI.
`List<String>`	`getExplicitAuthFlows()` Explicit authentication flows.
`List<String>`	`getLogoutURLs()` A list of allowed logout URLs for the identity providers.
`List<String>`	`getReadAttributes()` The read-only attributes of the user pool.
`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 where you want to update the user pool client.
`List<String>`	`getWriteAttributes()` The writeable attributes of the user pool.
`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`	`setCallbackURLs(Collection<String> callbackURLs)` A list of allowed 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 update user pool client request.
`void`	`setDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`void`	`setExplicitAuthFlows(Collection<String> explicitAuthFlows)` Explicit authentication flows.
`void`	`setLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`void`	`setReadAttributes(Collection<String> readAttributes)` The read-only attributes of the user pool.
`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 where you want to update the user pool client.
`void`	`setWriteAttributes(Collection<String> writeAttributes)` The writeable attributes of the user pool.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateUserPoolClientRequest`	`withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`UpdateUserPoolClientRequest`	`withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`UpdateUserPoolClientRequest`	`withAllowedOAuthFlows(String... allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`UpdateUserPoolClientRequest`	`withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`UpdateUserPoolClientRequest`	`withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` A list of allowed `OAuth` scopes.
`UpdateUserPoolClientRequest`	`withAllowedOAuthScopes(String... allowedOAuthScopes)` A list of allowed `OAuth` scopes.
`UpdateUserPoolClientRequest`	`withCallbackURLs(Collection<String> callbackURLs)` A list of allowed callback URLs for the identity providers.
`UpdateUserPoolClientRequest`	`withCallbackURLs(String... callbackURLs)` A list of allowed callback URLs for the identity providers.
`UpdateUserPoolClientRequest`	`withClientId(String clientId)` The ID of the client associated with the user pool.
`UpdateUserPoolClientRequest`	`withClientName(String clientName)` The client name from the update user pool client request.
`UpdateUserPoolClientRequest`	`withDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`UpdateUserPoolClientRequest`	`withExplicitAuthFlows(Collection<String> explicitAuthFlows)` Explicit authentication flows.
`UpdateUserPoolClientRequest`	`withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)` Explicit authentication flows.
`UpdateUserPoolClientRequest`	`withExplicitAuthFlows(String... explicitAuthFlows)` Explicit authentication flows.
`UpdateUserPoolClientRequest`	`withLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`UpdateUserPoolClientRequest`	`withLogoutURLs(String... logoutURLs)` A list of allowed logout URLs for the identity providers.
`UpdateUserPoolClientRequest`	`withReadAttributes(Collection<String> readAttributes)` The read-only attributes of the user pool.
`UpdateUserPoolClientRequest`	`withReadAttributes(String... readAttributes)` The read-only attributes of the user pool.
`UpdateUserPoolClientRequest`	`withRefreshTokenValidity(Integer refreshTokenValidity)` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`UpdateUserPoolClientRequest`	`withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`UpdateUserPoolClientRequest`	`withSupportedIdentityProviders(String... supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`UpdateUserPoolClientRequest`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool where you want to update the user pool client.
`UpdateUserPoolClientRequest`	`withWriteAttributes(Collection<String> writeAttributes)` The writeable attributes of the user pool.
`UpdateUserPoolClientRequest`	`withWriteAttributes(String... writeAttributes)` The writeable attributes of the user pool.

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

- Constructor Detail
  - UpdateUserPoolClientRequest
```
public UpdateUserPoolClientRequest()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where you want to update the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool where you want to update the user pool client.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool where you want to update the user pool client.
    
    Returns:
    
    The user pool ID for the user pool where you want to update the user pool client.
  - withUserPoolId
```
public UpdateUserPoolClientRequest withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where you want to update the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool where you want to update the user pool client.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Returns:
    
    The ID of the client associated with the user pool.
  - withClientId
```
public UpdateUserPoolClientRequest withClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientName
```
public void setClientName(String clientName)
```
    The client name from the update user pool client request.
    
    Parameters:
    
    clientName - The client name from the update user pool client request.
  - getClientName
```
public String getClientName()
```
    The client name from the update user pool client request.
    
    Returns:
    
    The client name from the update user pool client request.
  - withClientName
```
public UpdateUserPoolClientRequest withClientName(String clientName)
```
    The client name from the update user pool client request.
    
    Parameters:
    
    clientName - The client name from the update user pool client request.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRefreshTokenValidity
```
public void setRefreshTokenValidity(Integer refreshTokenValidity)
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Parameters:
    
    refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - getRefreshTokenValidity
```
public Integer getRefreshTokenValidity()
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Returns:
    
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
  - withRefreshTokenValidity
```
public UpdateUserPoolClientRequest withRefreshTokenValidity(Integer refreshTokenValidity)
```
    The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Parameters:
    
    refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReadAttributes
```
public List<String> getReadAttributes()
```
    The read-only attributes of the user pool.
    
    Returns:
    
    The read-only attributes of the user pool.
  - setReadAttributes
```
public void setReadAttributes(Collection<String> readAttributes)
```
    The read-only attributes of the user pool.
    
    Parameters:
    
    readAttributes - The read-only attributes of the user pool.
  - withReadAttributes
```
public UpdateUserPoolClientRequest withReadAttributes(String... readAttributes)
```
    The read-only attributes of the user pool.
    
    NOTE: This method appends the values to the existing list (if any). Use setReadAttributes(java.util.Collection) or withReadAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    readAttributes - The read-only attributes of the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReadAttributes
```
public UpdateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)
```
    The read-only attributes of the user pool.
    
    Parameters:
    
    readAttributes - The read-only attributes of the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWriteAttributes
```
public List<String> getWriteAttributes()
```
    The writeable attributes of the user pool.
    
    Returns:
    
    The writeable attributes of the user pool.
  - setWriteAttributes
```
public void setWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes of the user pool.
    
    Parameters:
    
    writeAttributes - The writeable attributes of the user pool.
  - withWriteAttributes
```
public UpdateUserPoolClientRequest withWriteAttributes(String... writeAttributes)
```
    The writeable attributes of the user pool.
    
    NOTE: This method appends the values to the existing list (if any). Use setWriteAttributes(java.util.Collection) or withWriteAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    writeAttributes - The writeable attributes of the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWriteAttributes
```
public UpdateUserPoolClientRequest withWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes of the user pool.
    
    Parameters:
    
    writeAttributes - The writeable attributes of the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExplicitAuthFlows
```
public List<String> getExplicitAuthFlows()
```
    Explicit authentication flows.
    
    Returns:
    
    Explicit authentication flows.
    
    See Also:
    
    ExplicitAuthFlowsType
  - setExplicitAuthFlows
```
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    Explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - Explicit authentication flows.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UpdateUserPoolClientRequest withExplicitAuthFlows(String... explicitAuthFlows)
```
    Explicit authentication flows.
    
    NOTE: This method appends the values to the existing list (if any). Use setExplicitAuthFlows(java.util.Collection) or withExplicitAuthFlows(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    explicitAuthFlows - Explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UpdateUserPoolClientRequest withExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    Explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - Explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UpdateUserPoolClientRequest withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
```
    Explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - Explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - 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 UpdateUserPoolClientRequest withSupportedIdentityProviders(String... supportedIdentityProviders)
```
    A list of provider names for the identity providers that are supported on this client.
    
    NOTE: This method appends the values to the existing list (if any). Use setSupportedIdentityProviders(java.util.Collection) or withSupportedIdentityProviders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSupportedIdentityProviders
```
public UpdateUserPoolClientRequest withSupportedIdentityProviders(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCallbackURLs
```
public List<String> getCallbackURLs()
```
    A list of allowed callback URLs for the identity providers.
    
    Returns:
    
    A list of allowed callback URLs for the identity providers.
  - setCallbackURLs
```
public void setCallbackURLs(Collection<String> callbackURLs)
```
    A list of allowed callback URLs for the identity providers.
    
    Parameters:
    
    callbackURLs - A list of allowed callback URLs for the identity providers.
  - withCallbackURLs
```
public UpdateUserPoolClientRequest withCallbackURLs(String... callbackURLs)
```
    A list of allowed callback URLs for the identity providers.
    
    NOTE: This method appends the values to the existing list (if any). Use setCallbackURLs(java.util.Collection) or withCallbackURLs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    callbackURLs - A list of allowed callback URLs for the identity providers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCallbackURLs
```
public UpdateUserPoolClientRequest withCallbackURLs(Collection<String> callbackURLs)
```
    A list of allowed callback URLs for the identity providers.
    
    Parameters:
    
    callbackURLs - A list of allowed callback URLs for the identity providers.
    
    Returns:
    
    Returns a reference to this 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 UpdateUserPoolClientRequest withLogoutURLs(String... logoutURLs)
```
    A list of allowed logout URLs for the identity providers.
    
    NOTE: This method appends the values to the existing list (if any). Use setLogoutURLs(java.util.Collection) or withLogoutURLs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the identity providers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLogoutURLs
```
public UpdateUserPoolClientRequest withLogoutURLs(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultRedirectURI
```
public void setDefaultRedirectURI(String defaultRedirectURI)
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    Parameters:
    
    defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
  - getDefaultRedirectURI
```
public String getDefaultRedirectURI()
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    Returns:
    
    The default redirect URI. Must be in the CallbackURLs list.
  - withDefaultRedirectURI
```
public UpdateUserPoolClientRequest withDefaultRedirectURI(String defaultRedirectURI)
```
    The default redirect URI. Must be in the CallbackURLs list.
    
    Parameters:
    
    defaultRedirectURI - The default redirect URI. Must be in the CallbackURLs list.
    
    Returns:
    
    Returns a reference to this 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.
    
    See Also:
    
    OAuthFlowType
  - 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.
    
    See Also:
    
    OAuthFlowType
  - withAllowedOAuthFlows
```
public UpdateUserPoolClientRequest 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowedOAuthFlows(java.util.Collection) or withAllowedOAuthFlows(java.util.Collection) if you want to override the existing values.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthFlowType
  - withAllowedOAuthFlows
```
public UpdateUserPoolClientRequest 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthFlowType
  - withAllowedOAuthFlows
```
public UpdateUserPoolClientRequest withAllowedOAuthFlows(OAuthFlowType... 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OAuthFlowType
  - 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 UpdateUserPoolClientRequest withAllowedOAuthScopes(String... allowedOAuthScopes)
```
    A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowedOAuthScopes(java.util.Collection) or withAllowedOAuthScopes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    allowedOAuthScopes - A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowedOAuthScopes
```
public UpdateUserPoolClientRequest withAllowedOAuthScopes(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".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withAllowedOAuthFlowsUserPoolClient
```
public UpdateUserPoolClientRequest withAllowedOAuthFlowsUserPoolClient(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.
    
    Returns:
    
    Returns a reference to this 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.
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateUserPoolClientRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class UpdateUserPoolClientRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateUserPoolClientRequest

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setClientId

getClientId

withClientId

setClientName

getClientName

withClientName

setRefreshTokenValidity

getRefreshTokenValidity

withRefreshTokenValidity

getReadAttributes

setReadAttributes

withReadAttributes

withReadAttributes

getWriteAttributes

setWriteAttributes

withWriteAttributes

withWriteAttributes

getExplicitAuthFlows

setExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

getSupportedIdentityProviders

setSupportedIdentityProviders

withSupportedIdentityProviders

withSupportedIdentityProviders

getCallbackURLs

setCallbackURLs

withCallbackURLs

withCallbackURLs

getLogoutURLs

setLogoutURLs

withLogoutURLs

withLogoutURLs

setDefaultRedirectURI

getDefaultRedirectURI

withDefaultRedirectURI

getAllowedOAuthFlows

setAllowedOAuthFlows

withAllowedOAuthFlows

withAllowedOAuthFlows

withAllowedOAuthFlows

getAllowedOAuthScopes

setAllowedOAuthScopes

withAllowedOAuthScopes

withAllowedOAuthScopes

setAllowedOAuthFlowsUserPoolClient

getAllowedOAuthFlowsUserPoolClient

withAllowedOAuthFlowsUserPoolClient

isAllowedOAuthFlowsUserPoolClient

toString

equals

hashCode

clone