public static interface UpdateUserPoolClientRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateUserPoolClientRequest.Builder,UpdateUserPoolClientRequest>
| Modifier and Type | Method and Description |
|---|---|
UpdateUserPoolClientRequest.Builder |
accessTokenValidity(Integer accessTokenValidity)
The time limit, after which the access token is no longer valid and cannot be used.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlows(Collection<OAuthFlowType> allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(String... allowedOAuthFlows)
The allowed OAuth flows.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes.
|
UpdateUserPoolClientRequest.Builder |
allowedOAuthScopes(String... allowedOAuthScopes)
The allowed OAuth scopes.
|
UpdateUserPoolClientRequest.Builder |
analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
|
default UpdateUserPoolClientRequest.Builder |
analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
|
UpdateUserPoolClientRequest.Builder |
callbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
callbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
clientId(String clientId)
The ID of the client associated with the user pool.
|
UpdateUserPoolClientRequest.Builder |
clientName(String clientName)
The client name from the update user pool client request.
|
UpdateUserPoolClientRequest.Builder |
defaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UpdateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(String... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
UpdateUserPoolClientRequest.Builder |
idTokenValidity(Integer idTokenValidity)
The time limit, after which the ID token is no longer valid and cannot be used.
|
UpdateUserPoolClientRequest.Builder |
logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
UpdateUserPoolClientRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UpdateUserPoolClientRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
UpdateUserPoolClientRequest.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.
|
UpdateUserPoolClientRequest.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.
|
UpdateUserPoolClientRequest.Builder |
readAttributes(Collection<String> readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest.Builder |
readAttributes(String... readAttributes)
The read-only attributes of the user pool.
|
UpdateUserPoolClientRequest.Builder |
refreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
UpdateUserPoolClientRequest.Builder |
supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
UpdateUserPoolClientRequest.Builder |
supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
default UpdateUserPoolClientRequest.Builder |
tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)
The units in which the validity times are represented in.
|
UpdateUserPoolClientRequest.Builder |
tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented in.
|
UpdateUserPoolClientRequest.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
|
UpdateUserPoolClientRequest.Builder |
writeAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
|
UpdateUserPoolClientRequest.Builder |
writeAttributes(String... writeAttributes)
The writeable attributes of the user pool.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateUserPoolClientRequest.Builder userPoolId(String userPoolId)
The user pool ID for the user pool where you want to update the user pool client.
userPoolId - The user pool ID for the user pool where you want to update the user pool client.UpdateUserPoolClientRequest.Builder clientId(String clientId)
The ID of the client associated with the user pool.
clientId - The ID of the client associated with the user pool.UpdateUserPoolClientRequest.Builder clientName(String clientName)
The client name from the update user pool client request.
clientName - The client name from the update user pool client request.UpdateUserPoolClientRequest.Builder refreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
refreshTokenValidity - The time limit, in days, after which the refresh token is no longer valid and cannot be used.UpdateUserPoolClientRequest.Builder accessTokenValidity(Integer accessTokenValidity)
The time limit, after which the access token is no longer valid and cannot be used.
accessTokenValidity - The time limit, after which the access token is no longer valid and cannot be used.UpdateUserPoolClientRequest.Builder idTokenValidity(Integer idTokenValidity)
The time limit, after which the ID token is no longer valid and cannot be used.
idTokenValidity - The time limit, after which the ID token is no longer valid and cannot be used.UpdateUserPoolClientRequest.Builder tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.
tokenValidityUnits - The units in which the validity times are represented in. Default for RefreshToken is days, and
default for ID and access tokens are hours.default UpdateUserPoolClientRequest.Builder tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)
The units in which the validity times are represented in. Default for RefreshToken is days, and default for ID and access tokens are hours.
This is a convenience that creates an instance of theTokenValidityUnitsType.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).tokenValidityUnits - a consumer that will call methods on TokenValidityUnitsType.BuildertokenValidityUnits(TokenValidityUnitsType)UpdateUserPoolClientRequest.Builder readAttributes(Collection<String> readAttributes)
The read-only attributes of the user pool.
readAttributes - The read-only attributes of the user pool.UpdateUserPoolClientRequest.Builder readAttributes(String... readAttributes)
The read-only attributes of the user pool.
readAttributes - The read-only attributes of the user pool.UpdateUserPoolClientRequest.Builder writeAttributes(Collection<String> writeAttributes)
The writeable attributes of the user pool.
writeAttributes - The writeable attributes of the user pool.UpdateUserPoolClientRequest.Builder writeAttributes(String... writeAttributes)
The writeable attributes of the user pool.
writeAttributes - The writeable attributes of the user pool.UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.Builder supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.UpdateUserPoolClientRequest.Builder supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client.UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.Builder logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs - A list of allowed logout URLs for the identity providers.UpdateUserPoolClientRequest.Builder logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
logoutURLs - A list of allowed logout URLs for the identity providers.UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.
UpdateUserPoolClientRequest.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.
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.UpdateUserPoolClientRequest.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.
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.UpdateUserPoolClientRequest.Builder allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Cognito user
pools.UpdateUserPoolClientRequest.Builder analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
analyticsConfiguration - The Amazon Pinpoint analytics configuration for collecting metrics for this user pool. In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
default UpdateUserPoolClientRequest.Builder analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
In regions where Pinpoint is not available, Cognito User Pools only supports sending events to Amazon Pinpoint projects in us-east-1. In regions where Pinpoint is available, Cognito User Pools will support sending events to Amazon Pinpoint projects within that same region.
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).analyticsConfiguration - a consumer that will call methods on AnalyticsConfigurationType.BuilderanalyticsConfiguration(AnalyticsConfigurationType)UpdateUserPoolClientRequest.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.
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.
PreventUserExistenceErrorTypes,
PreventUserExistenceErrorTypesUpdateUserPoolClientRequest.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.
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.
PreventUserExistenceErrorTypes,
PreventUserExistenceErrorTypesUpdateUserPoolClientRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderUpdateUserPoolClientRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.