UserPoolClientType (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Contains information about a user pool client.

See Also:: AWS API Documentation, 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
`UserPoolClientType`	`clone()`
`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 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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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 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(OAuthFlowType... 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`	`withCallbackURLs(Collection<String> callbackURLs)` A list of allowed callback URLs for the identity providers.
`UserPoolClientType`	`withCallbackURLs(String... callbackURLs)` A list of allowed 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(ExplicitAuthFlowsType... 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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserPoolClientType
```
public UserPoolClientType()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool client.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool client.
    
    Returns:
    
    The user pool ID for the user pool client.
  - withUserPoolId
```
public UserPoolClientType withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool client.
    
    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 user pool request of the client type.
    
    Parameters:
    
    clientName - The client name from the user pool request of the client type.
  - getClientName
```
public String getClientName()
```
    The client name from the user pool request of the client type.
    
    Returns:
    
    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.
    
    Parameters:
    
    clientName - The client name from the user pool request of the client type.
    
    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 UserPoolClientType 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.
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    The client secret from the user pool request of the client type.
    
    Parameters:
    
    clientSecret - The client secret from the user pool request of the client type.
  - getClientSecret
```
public String getClientSecret()
```
    The client secret from the user pool request of the client type.
    
    Returns:
    
    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.
    
    Parameters:
    
    clientSecret - The client secret from the user pool request of the client type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the user pool client was last modified.
    
    Returns:
    
    The date the user pool client was last modified.
  - withLastModifiedDate
```
public UserPoolClientType withLastModifiedDate(Date lastModifiedDate)
```
    The date the user pool client was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the user pool client was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the user pool client was created.
    
    Parameters:
    
    creationDate - The date the user pool client was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the user pool client was created.
    
    Returns:
    
    The date the user pool client was created.
  - withCreationDate
```
public UserPoolClientType withCreationDate(Date creationDate)
```
    The date the user pool client was created.
    
    Parameters:
    
    creationDate - The date the user pool client was created.
    
    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 UserPoolClientType 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.
    
    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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReadAttributes
```
public UserPoolClientType withReadAttributes(Collection<String> readAttributes)
```
    The Read-only attributes.
    
    Parameters:
    
    readAttributes - The Read-only attributes.
    
    Returns:
    
    Returns a reference to this 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.
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWriteAttributes
```
public UserPoolClientType withWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes.
    
    Parameters:
    
    writeAttributes - The writeable attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExplicitAuthFlows
```
public List<String> getExplicitAuthFlows()
```
    The explicit authentication flows.
    
    Returns:
    
    The explicit authentication flows.
    
    See Also:
    
    ExplicitAuthFlowsType
  - setExplicitAuthFlows
```
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    The explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - The explicit authentication flows.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(String... explicitAuthFlows)
```
    The 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 - The explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    The explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - The explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
```
    The explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - The 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 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.
    
    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 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.
    
    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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType 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 UserPoolClientType clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UserPoolClientType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPoolClientType

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setClientName

getClientName

withClientName

setClientId

getClientId

withClientId

setClientSecret

getClientSecret

withClientSecret

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setCreationDate

getCreationDate

withCreationDate

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

marshall