CreateUserPoolClientRequest (AWS SDK for Java

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

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserPoolClientRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the request to create a 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

CreateUserPoolClientRequest()

Constructors
Constructor and Description
`CreateUserPoolClientRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateUserPoolClientRequest`	`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.
`AnalyticsConfigurationType`	`getAnalyticsConfiguration()` The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
`List<String>`	`getCallbackURLs()` A list of allowed redirect (callback) URLs for the identity providers.
`String`	`getClientName()` The client name for the user pool client you would like to create.
`String`	`getDefaultRedirectURI()` The default redirect URI.
`List<String>`	`getExplicitAuthFlows()` The explicit authentication flows.
`Boolean`	`getGenerateSecret()` Boolean to specify whether you want to generate a secret for the user pool client being created.
`List<String>`	`getLogoutURLs()` A list of allowed logout URLs for the identity providers.
`List<String>`	`getReadAttributes()` The read 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 where you want to create a user pool client.
`List<String>`	`getWriteAttributes()` The user pool attributes that the app client can write to.
`int`	`hashCode()`
`Boolean`	`isAllowedOAuthFlowsUserPoolClient()` Set to `True` if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`Boolean`	`isGenerateSecret()` Boolean to specify whether you want to generate a secret for the user pool client being created.
`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 collecting metrics for this user pool.
`void`	`setCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`void`	`setClientName(String clientName)` The client name for the user pool client you would like to create.
`void`	`setDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`void`	`setExplicitAuthFlows(Collection<String> explicitAuthFlows)` The explicit authentication flows.
`void`	`setGenerateSecret(Boolean generateSecret)` Boolean to specify whether you want to generate a secret for the user pool client being created.
`void`	`setLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`void`	`setReadAttributes(Collection<String> readAttributes)` The read 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 where you want to create a user pool client.
`void`	`setWriteAttributes(Collection<String> writeAttributes)` The user pool attributes that the app client can write to.
`String`	`toString()` Returns a string representation of this object.
`CreateUserPoolClientRequest`	`withAllowedOAuthFlows(Collection<String> allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`CreateUserPoolClientRequest`	`withAllowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`CreateUserPoolClientRequest`	`withAllowedOAuthFlows(String... allowedOAuthFlows)` Set to `code` to initiate a code grant flow, which provides an authorization code as the response.
`CreateUserPoolClientRequest`	`withAllowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to `True` if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`CreateUserPoolClientRequest`	`withAllowedOAuthScopes(Collection<String> allowedOAuthScopes)` A list of allowed `OAuth` scopes.
`CreateUserPoolClientRequest`	`withAllowedOAuthScopes(String... allowedOAuthScopes)` A list of allowed `OAuth` scopes.
`CreateUserPoolClientRequest`	`withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
`CreateUserPoolClientRequest`	`withCallbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`CreateUserPoolClientRequest`	`withCallbackURLs(String... callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`CreateUserPoolClientRequest`	`withClientName(String clientName)` The client name for the user pool client you would like to create.
`CreateUserPoolClientRequest`	`withDefaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`CreateUserPoolClientRequest`	`withExplicitAuthFlows(Collection<String> explicitAuthFlows)` The explicit authentication flows.
`CreateUserPoolClientRequest`	`withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)` The explicit authentication flows.
`CreateUserPoolClientRequest`	`withExplicitAuthFlows(String... explicitAuthFlows)` The explicit authentication flows.
`CreateUserPoolClientRequest`	`withGenerateSecret(Boolean generateSecret)` Boolean to specify whether you want to generate a secret for the user pool client being created.
`CreateUserPoolClientRequest`	`withLogoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`CreateUserPoolClientRequest`	`withLogoutURLs(String... logoutURLs)` A list of allowed logout URLs for the identity providers.
`CreateUserPoolClientRequest`	`withReadAttributes(Collection<String> readAttributes)` The read attributes.
`CreateUserPoolClientRequest`	`withReadAttributes(String... readAttributes)` The read attributes.
`CreateUserPoolClientRequest`	`withRefreshTokenValidity(Integer refreshTokenValidity)` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`CreateUserPoolClientRequest`	`withSupportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`CreateUserPoolClientRequest`	`withSupportedIdentityProviders(String... supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`CreateUserPoolClientRequest`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool where you want to create a user pool client.
`CreateUserPoolClientRequest`	`withWriteAttributes(Collection<String> writeAttributes)` The user pool attributes that the app client can write to.
`CreateUserPoolClientRequest`	`withWriteAttributes(String... writeAttributes)` The user pool attributes that the app client can write to.

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

- Constructor Detail
  - CreateUserPoolClientRequest
```
public CreateUserPoolClientRequest()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where you want to create a user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool where you want to create a user pool client.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool where you want to create a user pool client.
    
    Returns:
    
    The user pool ID for the user pool where you want to create a user pool client.
  - withUserPoolId
```
public CreateUserPoolClientRequest withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where you want to create a user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool where you want to create a 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 for the user pool client you would like to create.
    
    Parameters:
    
    clientName - The client name for the user pool client you would like to create.
  - getClientName
```
public String getClientName()
```
    The client name for the user pool client you would like to create.
    
    Returns:
    
    The client name for the user pool client you would like to create.
  - withClientName
```
public CreateUserPoolClientRequest withClientName(String clientName)
```
    The client name for the user pool client you would like to create.
    
    Parameters:
    
    clientName - The client name for the user pool client you would like to create.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGenerateSecret
```
public void setGenerateSecret(Boolean generateSecret)
```
    Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Parameters:
    
    generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.
  - getGenerateSecret
```
public Boolean getGenerateSecret()
```
    Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Returns:
    
    Boolean to specify whether you want to generate a secret for the user pool client being created.
  - withGenerateSecret
```
public CreateUserPoolClientRequest withGenerateSecret(Boolean generateSecret)
```
    Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Parameters:
    
    generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isGenerateSecret
```
public Boolean isGenerateSecret()
```
    Boolean to specify whether you want to generate a secret for the user pool client being created.
    
    Returns:
    
    Boolean to specify whether you want to generate a secret for the user pool client being created.
  - 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 CreateUserPoolClientRequest 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 attributes.
    
    Returns:
    
    The read attributes.
  - setReadAttributes
```
public void setReadAttributes(Collection<String> readAttributes)
```
    The read attributes.
    
    Parameters:
    
    readAttributes - The read attributes.
  - withReadAttributes
```
public CreateUserPoolClientRequest withReadAttributes(String... readAttributes)
```
    The read 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 attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReadAttributes
```
public CreateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)
```
    The read attributes.
    
    Parameters:
    
    readAttributes - The read attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWriteAttributes
```
public List<String> getWriteAttributes()
```
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
    
    Returns:
    
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
  - setWriteAttributes
```
public void setWriteAttributes(Collection<String> writeAttributes)
```
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
    
    Parameters:
    
    writeAttributes - The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
  - withWriteAttributes
```
public CreateUserPoolClientRequest withWriteAttributes(String... writeAttributes)
```
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your 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 user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWriteAttributes
```
public CreateUserPoolClientRequest withWriteAttributes(Collection<String> writeAttributes)
```
    The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
    
    Parameters:
    
    writeAttributes - The user pool attributes that the app client can write to.
    
    If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
    
    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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 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 CreateUserPoolClientRequest 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.
    
    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 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCallbackURLs
```
public CreateUserPoolClientRequest 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.
    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:
    
    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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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.
    
    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:
    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.
  - 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.
    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.
  - withDefaultRedirectURI
```
public CreateUserPoolClientRequest 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.
    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:
    
    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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest 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.
  - setAnalyticsConfiguration
```
public void setAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
  - getAnalyticsConfiguration
```
public AnalyticsConfigurationType getAnalyticsConfiguration()
```
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    Returns:
    
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
  - withAnalyticsConfiguration
```
public CreateUserPoolClientRequest withAnalyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 CreateUserPoolClientRequest 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 CreateUserPoolClientRequest

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

CreateUserPoolClientRequest

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setClientName

getClientName

withClientName

setGenerateSecret

getGenerateSecret

withGenerateSecret

isGenerateSecret

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

setAnalyticsConfiguration

getAnalyticsConfiguration

withAnalyticsConfiguration

toString

equals

hashCode

clone