UserPoolClientType.Builder (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.17.241 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 access token time limit.
`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 Amazon 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 OAuth scopes that your app client supports.
`UserPoolClientType.Builder`	`allowedOAuthScopes(String... allowedOAuthScopes)` The OAuth scopes that your app client supports.
`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 IdPs.
`UserPoolClientType.Builder`	`callbackURLs(String... callbackURLs)` A list of allowed redirect (callback) URLs for the IdPs.
`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`	`enablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)` When `EnablePropagateAdditionalUserContextData` is true, Amazon Cognito accepts an `IpAddress` value that you send in the `UserContextData` parameter.
`UserPoolClientType.Builder`	`enableTokenRevocation(Boolean enableTokenRevocation)` Indicates whether token revocation is activated for the user pool client.
`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 ID token time limit.
`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 IdPs.
`UserPoolClientType.Builder`	`logoutURLs(String... logoutURLs)` A list of allowed logout URLs for the IdPs.
`UserPoolClientType.Builder`	`preventUserExistenceErrors(PreventUserExistenceErrorTypes preventUserExistenceErrors)` Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.
`UserPoolClientType.Builder`	`preventUserExistenceErrors(String preventUserExistenceErrors)` Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't 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 refresh token time limit.
`UserPoolClientType.Builder`	`supportedIdentityProviders(Collection<String> supportedIdentityProviders)` A list of provider names for the IdPs that this client supports.
`UserPoolClientType.Builder`	`supportedIdentityProviders(String... supportedIdentityProviders)` A list of provider names for the IdPs that this client supports.
`default UserPoolClientType.Builder`	`tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)` The time units used to specify the token validity times of each token type: ID, access, and refresh.
`UserPoolClientType.Builder`	`tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)` The time units used to specify the token validity times of each token type: ID, access, and refresh.
`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 refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
    
    For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
    
    The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
    
    Parameters:
    
    refreshTokenValidity - The refresh token time limit. After this limit expires, your user can't use their refresh token. To specify the time unit for RefreshTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
    
    For example, when you set RefreshTokenValidity as 10 and TokenValidityUnits as days, your user can refresh their session and retrieve new access and ID tokens for 10 days.
    
    The default time unit for RefreshTokenValidity in an API request is days. You can't set RefreshTokenValidity to 0. If you do, Amazon Cognito overrides the value with the default value of 30 days. Valid range is displayed below in seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - accessTokenValidity
```
UserPoolClientType.Builder accessTokenValidity(Integer accessTokenValidity)
```
    The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
    
    For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
    
    The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
    
    Parameters:
    
    accessTokenValidity - The access token time limit. After this limit expires, your user can't use their access token. To specify the time unit for AccessTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
    
    For example, when you set AccessTokenValidity to 10 and TokenValidityUnits to hours, your user can authorize access with their access token for 10 hours.
    
    The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - idTokenValidity
```
UserPoolClientType.Builder idTokenValidity(Integer idTokenValidity)
```
    The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
    
    For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
    
    The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
    
    Parameters:
    
    idTokenValidity - The ID token time limit. After this limit expires, your user can't use their ID token. To specify the time unit for IdTokenValidity as seconds, minutes, hours, or days, set a TokenValidityUnits value in your API request.
    
    For example, when you set IdTokenValidity as 10 and TokenValidityUnits as hours, your user can authenticate their session with their ID token for 10 hours.
    
    The default time unit for AccessTokenValidity in an API request is hours. Valid range is displayed below in seconds.
    
    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 each token type: ID, access, and refresh.
    
    Parameters:
    
    tokenValidityUnits - The time units used to specify the token validity times of each token type: ID, access, and refresh.
    
    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 each token type: ID, access, and refresh.
    This is a convenience method 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    - ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    - ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 no longer supported in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix must be used only along with values including the 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, Amazon Cognito receives the password in the request instead of using the Secure Remote Password (SRP) protocol to verify passwords.
    
    ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
    
    ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Amazon 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 IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
    
    Parameters:
    
    supportedIdentityProviders - A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
    
    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 IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
    
    Parameters:
    
    supportedIdentityProviders - A list of provider names for the IdPs that this client supports. The following are supported: COGNITO, Facebook, Google LoginWithAmazon, and the names of your own SAML and OIDC providers.
    
    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 IdPs.
    
    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 IdPs.
    
    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 IdPs.
    
    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 IdPs.
    
    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 IdPs.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the IdPs.
    
    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 IdPs.
    
    Parameters:
    
    logoutURLs - A list of allowed logout URLs for the IdPs.
    
    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.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID 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.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID 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.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID 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.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID and client secret.
    
    Parameters:
    
    allowedOAuthFlows - The allowed OAuth flows.
    
    code
    
    Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the /oauth2/token endpoint.
    
    implicit
    
    Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
    
    client_credentials
    
    Issue the access token from the /oauth2/token endpoint directly to a non-person user using a combination of the client ID 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 OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Parameters:
    
    allowedOAuthScopes - The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - allowedOAuthScopes
```
UserPoolClientType.Builder allowedOAuthScopes(String... allowedOAuthScopes)
```
    The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    Parameters:
    
    allowedOAuthScopes - The OAuth scopes that your app client supports. Possible values that OAuth provides are phone, email, openid, and profile. Possible values that Amazon Web Services provides are aws.cognito.signin.user.admin. Amazon Cognito also supports custom scopes that you create in Resource Servers.
    
    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 Amazon Cognito user pools.
    
    Parameters:
    
    allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon 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.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
    
    Parameters:
    
    analyticsConfiguration - The Amazon Pinpoint analytics configuration for the user pool client.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where 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.
    
    Amazon Cognito user pools only support sending events to Amazon Pinpoint projects in the US East (N. Virginia) us-east-1 Region, regardless of the Region where the user pool resides.
    This is a convenience method 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)
```
    Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Parameters:
    preventUserExistenceErrors - Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.
    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)
```
    Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    - ENABLED - This prevents user existence-related errors.
    - LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Parameters:
    preventUserExistenceErrors - Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool. When set to ENABLED and the user doesn't exist, authentication returns an error indicating either the username or password was incorrect. Account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs return a UserNotFoundException exception if the user doesn't exist in the user pool.
    
    Valid values include:
    
    ENABLED - This prevents user existence-related errors.
    
    LEGACY - This represents the old behavior of Amazon Cognito where user existence related errors aren't prevented.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PreventUserExistenceErrorTypes, PreventUserExistenceErrorTypes
  - enableTokenRevocation
```
UserPoolClientType.Builder enableTokenRevocation(Boolean enableTokenRevocation)
```
    Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
    
    Parameters:
    
    enableTokenRevocation - Indicates whether token revocation is activated for the user pool client. When you create a new user pool client, token revocation is activated by default. For more information about revoking tokens, see RevokeToken.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enablePropagateAdditionalUserContextData
```
UserPoolClientType.Builder enablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
```
    When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
    
    Parameters:
    
    enablePropagateAdditionalUserContextData - When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an IpAddress value that you send in the UserContextData parameter. The UserContextData parameter sends information to Amazon Cognito advanced security for risk analysis. You can send UserContextData when you sign in Amazon Cognito native users with the InitiateAuth and RespondToAuthChallenge API operations.
    
    When EnablePropagateAdditionalUserContextData is false, you can't send your user's source IP address to Amazon Cognito advanced security with unauthenticated API operations. EnablePropagateAdditionalUserContextData doesn't affect whether you can send a source IP address in a ContextData parameter with the authenticated API operations AdminInitiateAuth and AdminRespondToAuthChallenge.
    
    You can only activate EnablePropagateAdditionalUserContextData in an app client that has a client secret. For more information about propagation of user context data, see Adding user device and session data to API requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

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

enableTokenRevocation

enablePropagateAdditionalUserContextData