UserPoolClientType.Builder (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.14.0 API)

All Superinterfaces:

Buildable, CopyableBuilder<UserPoolClientType.Builder,UserPoolClientType>, SdkBuilder<UserPoolClientType.Builder,UserPoolClientType>, SdkPojo

Enclosing class:

UserPoolClientType
```
public static interface UserPoolClientType.Builder
extends SdkPojo, CopyableBuilder<UserPoolClientType.Builder,UserPoolClientType>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`UserPoolClientType.Builder`	`accessTokenValidity(Integer accessTokenValidity)` The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.
`UserPoolClientType.Builder`	`allowedOAuthFlows(Collection<OAuthFlowType> allowedOAuthFlows)` The allowed OAuth flows.
`UserPoolClientType.Builder`	`allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)` The allowed OAuth flows.
`UserPoolClientType.Builder`	`allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)` Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
`UserPoolClientType.Builder`	`allowedOAuthFlowsWithStrings(Collection<String> allowedOAuthFlows)` The allowed OAuth flows.
`UserPoolClientType.Builder`	`allowedOAuthFlowsWithStrings(String... allowedOAuthFlows)` The allowed OAuth flows.
`UserPoolClientType.Builder`	`allowedOAuthScopes(Collection<String> allowedOAuthScopes)` The allowed OAuth scopes.
`UserPoolClientType.Builder`	`allowedOAuthScopes(String... allowedOAuthScopes)` The allowed OAuth scopes.
`UserPoolClientType.Builder`	`analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`default UserPoolClientType.Builder`	`analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)` The Amazon Pinpoint analytics configuration for the user pool client.
`UserPoolClientType.Builder`	`callbackURLs(Collection<String> callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`UserPoolClientType.Builder`	`callbackURLs(String... callbackURLs)` A list of allowed redirect (callback) URLs for the identity providers.
`UserPoolClientType.Builder`	`clientId(String clientId)` The ID of the client associated with the user pool.
`UserPoolClientType.Builder`	`clientName(String clientName)` The client name from the user pool request of the client type.
`UserPoolClientType.Builder`	`clientSecret(String clientSecret)` The client secret from the user pool request of the client type.
`UserPoolClientType.Builder`	`creationDate(Instant creationDate)` The date the user pool client was created.
`UserPoolClientType.Builder`	`defaultRedirectURI(String defaultRedirectURI)` The default redirect URI.
`UserPoolClientType.Builder`	`explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`UserPoolClientType.Builder`	`explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`UserPoolClientType.Builder`	`explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`UserPoolClientType.Builder`	`explicitAuthFlowsWithStrings(String... explicitAuthFlows)` The authentication flows that are supported by the user pool clients.
`UserPoolClientType.Builder`	`idTokenValidity(Integer idTokenValidity)` The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.
`UserPoolClientType.Builder`	`lastModifiedDate(Instant lastModifiedDate)` The date the user pool client was last modified.
`UserPoolClientType.Builder`	`logoutURLs(Collection<String> logoutURLs)` A list of allowed logout URLs for the identity providers.
`UserPoolClientType.Builder`	`logoutURLs(String... logoutURLs)` A list of allowed logout URLs for the identity providers.
`UserPoolClientType.Builder`	`preventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)` Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
`UserPoolClientType.Builder`	`preventUserExistenceErrors(String preventUserExistenceErrors)` Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool.
`UserPoolClientType.Builder`	`readAttributes(Collection<String> readAttributes)` The Read-only attributes.
`UserPoolClientType.Builder`	`readAttributes(String... readAttributes)` The Read-only attributes.
`UserPoolClientType.Builder`	`refreshTokenValidity(Integer refreshTokenValidity)` The time limit, in days, after which the refresh token is no longer valid and cannot be used.
`UserPoolClientType.Builder`	`supportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`UserPoolClientType.Builder`	`supportedIdentityProviders(String... supportedIdentityProviders)` A list of provider names for the identity providers that are supported on this client.
`default UserPoolClientType.Builder`	`tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)` The time units used to specify the token validity times of their respective token.
`UserPoolClientType.Builder`	`tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)` The time units used to specify the token validity times of their respective token.
`UserPoolClientType.Builder`	`userPoolId(String userPoolId)` The user pool ID for the user pool client.
`UserPoolClientType.Builder`	`writeAttributes(Collection<String> writeAttributes)` The writeable attributes.
`UserPoolClientType.Builder`	`writeAttributes(String... writeAttributes)` The writeable attributes.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - userPoolId
```
UserPoolClientType.Builder userPoolId(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.
  - clientName
```
UserPoolClientType.Builder clientName(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.
  - clientId
```
UserPoolClientType.Builder clientId(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.
  - clientSecret
```
UserPoolClientType.Builder clientSecret(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.
  - lastModifiedDate
```
UserPoolClientType.Builder lastModifiedDate(Instant 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.
  - creationDate
```
UserPoolClientType.Builder creationDate(Instant 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.
  - refreshTokenValidity
```
UserPoolClientType.Builder refreshTokenValidity(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.
  - accessTokenValidity
```
UserPoolClientType.Builder accessTokenValidity(Integer accessTokenValidity)
```
    The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.
    
    Parameters:
    
    accessTokenValidity - The time limit, specified by tokenValidityUnits, defaulting to hours, after which the access token is no longer valid and cannot be used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - idTokenValidity
```
UserPoolClientType.Builder idTokenValidity(Integer idTokenValidity)
```
    The time limit, specified by tokenValidityUnits, defaulting to hours, after which the refresh token is no longer valid and cannot be used.
    
    Parameters:
    
    idTokenValidity - The time limit, specified by tokenValidityUnits, defaulting to hours, 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.
  - tokenValidityUnits
```
UserPoolClientType.Builder tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
```
    The time units used to specify the token validity times of their respective token.
    
    Parameters:
    
    tokenValidityUnits - The time units used to specify the token validity times of their respective token.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tokenValidityUnits
```
default UserPoolClientType.Builder tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)
```
    The time units used to specify the token validity times of their respective token.
    This is a convenience that creates an instance of the TokenValidityUnitsType.Builder avoiding the need to create one manually via TokenValidityUnitsType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tokenValidityUnits(TokenValidityUnitsType).
    
    Parameters:
    
    tokenValidityUnits - a consumer that will call methods on TokenValidityUnitsType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    tokenValidityUnits(TokenValidityUnitsType)
  - readAttributes
```
UserPoolClientType.Builder readAttributes(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.
  - readAttributes
```
UserPoolClientType.Builder readAttributes(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.
  - writeAttributes
```
UserPoolClientType.Builder writeAttributes(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.
  - writeAttributes
```
UserPoolClientType.Builder writeAttributes(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.
  - explicitAuthFlowsWithStrings
```
UserPoolClientType.Builder explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)
```
    The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    - ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    - ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Parameters:
    explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    
    ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    
    ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    
    ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - explicitAuthFlowsWithStrings
```
UserPoolClientType.Builder explicitAuthFlowsWithStrings(String... explicitAuthFlows)
```
    The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    - ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    - ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Parameters:
    explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    
    ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    
    ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    
    ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - explicitAuthFlows
```
UserPoolClientType.Builder explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)
```
    The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    - ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    - ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Parameters:
    explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    
    ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    
    ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    
    ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - explicitAuthFlows
```
UserPoolClientType.Builder explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
```
    The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    - ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    - ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    - ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Parameters:
    explicitAuthFlows - The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
    
    Valid values include:
    
    ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords.
    
    ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
    
    ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - supportedIdentityProviders
```
UserPoolClientType.Builder supportedIdentityProviders(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.
  - supportedIdentityProviders
```
UserPoolClientType.Builder supportedIdentityProviders(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.
  - callbackURLs
```
UserPoolClientType.Builder callbackURLs(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.
  - callbackURLs
```
UserPoolClientType.Builder callbackURLs(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.
  - logoutURLs
```
UserPoolClientType.Builder logoutURLs(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.
  - logoutURLs
```
UserPoolClientType.Builder logoutURLs(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.
  - defaultRedirectURI
```
UserPoolClientType.Builder defaultRedirectURI(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.
  - allowedOAuthFlowsWithStrings
```
UserPoolClientType.Builder allowedOAuthFlowsWithStrings(Collection<String> allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowedOAuthFlowsWithStrings
```
UserPoolClientType.Builder allowedOAuthFlowsWithStrings(String... allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowedOAuthFlows
```
UserPoolClientType.Builder allowedOAuthFlows(Collection<OAuthFlowType> allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowedOAuthFlows
```
UserPoolClientType.Builder allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
```
    The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    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 implicit to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
    
    Set to client_credentials to specify that the client should get the access token (and, optionally, ID token, based on scopes) from the token endpoint using a combination of client and client_secret.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowedOAuthScopes
```
UserPoolClientType.Builder allowedOAuthScopes(Collection<String> allowedOAuthScopes)
```
    The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Parameters:
    
    allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowedOAuthScopes
```
UserPoolClientType.Builder allowedOAuthScopes(String... allowedOAuthScopes)
```
    The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Parameters:
    
    allowedOAuthScopes - The allowed OAuth scopes. Possible values provided by OAuth are: phone, email, openid, and profile. Possible values provided by AWS are: aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also supported.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowedOAuthFlowsUserPoolClient
```
UserPoolClientType.Builder allowedOAuthFlowsUserPoolClient(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.
  - analyticsConfiguration
```
UserPoolClientType.Builder analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - analyticsConfiguration
```
default UserPoolClientType.Builder analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
```
    The Amazon Pinpoint analytics configuration for the user pool client.
    
    Cognito User Pools only supports sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the region in which the user pool resides.
    This is a convenience that creates an instance of the AnalyticsConfigurationType.Builder avoiding the need to create one manually via AnalyticsConfigurationType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to analyticsConfiguration(AnalyticsConfigurationType).
    
    Parameters:
    
    analyticsConfiguration - a consumer that will call methods on AnalyticsConfigurationType.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    analyticsConfiguration(AnalyticsConfigurationType)
  - preventUserExistenceErrors
```
UserPoolClientType.Builder preventUserExistenceErrors(String preventUserExistenceErrors)
```
    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Parameters:
    preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreventUserExistenceErrorTypes, PreventUserExistenceErrorTypes
  - preventUserExistenceErrors
```
UserPoolClientType.Builder preventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)
```
    Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Parameters:
    preventUserExistenceErrors - Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented.
    
    After February 15th 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreventUserExistenceErrorTypes, PreventUserExistenceErrorTypes

Interface UserPoolClientType.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

userPoolId

clientName

clientId

clientSecret

lastModifiedDate

creationDate

refreshTokenValidity

accessTokenValidity

idTokenValidity

tokenValidityUnits

tokenValidityUnits

readAttributes

readAttributes

writeAttributes

writeAttributes

explicitAuthFlowsWithStrings

explicitAuthFlowsWithStrings

explicitAuthFlows

explicitAuthFlows

supportedIdentityProviders

supportedIdentityProviders

callbackURLs

callbackURLs

logoutURLs

logoutURLs

defaultRedirectURI

allowedOAuthFlowsWithStrings

allowedOAuthFlowsWithStrings

allowedOAuthFlows

allowedOAuthFlows

allowedOAuthScopes

allowedOAuthScopes

allowedOAuthFlowsUserPoolClient

analyticsConfiguration

analyticsConfiguration

preventUserExistenceErrors

preventUserExistenceErrors