public static interface CreateUserPoolClientRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<CreateUserPoolClientRequest.Builder,CreateUserPoolClientRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateUserPoolClientRequest.Builder |
accessTokenValidity(Integer accessTokenValidity)
The access token time limit.
|
CreateUserPoolClientRequest.Builder |
allowedOAuthFlows(Collection<OAuthFlowType> allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest.Builder |
allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest.Builder |
allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user
pools.
|
CreateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest.Builder |
allowedOAuthFlowsWithStrings(String... allowedOAuthFlows)
The allowed OAuth flows.
|
CreateUserPoolClientRequest.Builder |
allowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes.
|
CreateUserPoolClientRequest.Builder |
allowedOAuthScopes(String... allowedOAuthScopes)
The allowed OAuth scopes.
|
CreateUserPoolClientRequest.Builder |
analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint
campaign.
|
default CreateUserPoolClientRequest.Builder |
analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint
campaign.
|
CreateUserPoolClientRequest.Builder |
callbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
CreateUserPoolClientRequest.Builder |
callbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the IdPs.
|
CreateUserPoolClientRequest.Builder |
clientName(String clientName)
The client name for the user pool client you would like to create.
|
CreateUserPoolClientRequest.Builder |
defaultRedirectURI(String defaultRedirectURI)
The default redirect URI.
|
CreateUserPoolClientRequest.Builder |
enablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data.
|
CreateUserPoolClientRequest.Builder |
enableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlows(Collection<ExplicitAuthFlowsType> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(Collection<String> explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
CreateUserPoolClientRequest.Builder |
explicitAuthFlowsWithStrings(String... explicitAuthFlows)
The authentication flows that are supported by the user pool clients.
|
CreateUserPoolClientRequest.Builder |
generateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
|
CreateUserPoolClientRequest.Builder |
idTokenValidity(Integer idTokenValidity)
The ID token time limit.
|
CreateUserPoolClientRequest.Builder |
logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
|
CreateUserPoolClientRequest.Builder |
logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the IdPs.
|
CreateUserPoolClientRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateUserPoolClientRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateUserPoolClientRequest.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.
|
CreateUserPoolClientRequest.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.
|
CreateUserPoolClientRequest.Builder |
readAttributes(Collection<String> readAttributes)
The read attributes.
|
CreateUserPoolClientRequest.Builder |
readAttributes(String... readAttributes)
The read attributes.
|
CreateUserPoolClientRequest.Builder |
refreshTokenValidity(Integer refreshTokenValidity)
The refresh token time limit.
|
CreateUserPoolClientRequest.Builder |
supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
CreateUserPoolClientRequest.Builder |
supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the IdPs that this client supports.
|
default CreateUserPoolClientRequest.Builder |
tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)
The units in which the validity times are represented.
|
CreateUserPoolClientRequest.Builder |
tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented.
|
CreateUserPoolClientRequest.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
|
CreateUserPoolClientRequest.Builder |
writeAttributes(Collection<String> writeAttributes)
The user pool attributes that the app client can write to.
|
CreateUserPoolClientRequest.Builder |
writeAttributes(String... writeAttributes)
The user pool attributes that the app client can write to.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateUserPoolClientRequest.Builder userPoolId(String userPoolId)
The user pool ID for the user pool where you want to create a user pool client.
userPoolId - The user pool ID for the user pool where you want to create a user pool client.CreateUserPoolClientRequest.Builder clientName(String clientName)
The client name for the user pool client you would like to create.
clientName - The client name for the user pool client you would like to create.CreateUserPoolClientRequest.Builder generateSecret(Boolean generateSecret)
Boolean to specify whether you want to generate a secret for the user pool client being created.
generateSecret - Boolean to specify whether you want to generate a secret for the user pool client being created.CreateUserPoolClientRequest.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.
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.
CreateUserPoolClientRequest.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.
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.
CreateUserPoolClientRequest.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.
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.
CreateUserPoolClientRequest.Builder tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
tokenValidityUnits - The units in which the validity times are represented. The default unit for RefreshToken is days, and
default for ID and access tokens are hours.default CreateUserPoolClientRequest.Builder tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)
The units in which the validity times are represented. The default unit for RefreshToken is days, and default for ID and access tokens are hours.
This is a convenience method 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)CreateUserPoolClientRequest.Builder readAttributes(Collection<String> readAttributes)
The read attributes.
readAttributes - The read attributes.CreateUserPoolClientRequest.Builder readAttributes(String... readAttributes)
The read attributes.
readAttributes - The read attributes.CreateUserPoolClientRequest.Builder writeAttributes(Collection<String> writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
CreateUserPoolClientRequest.Builder writeAttributes(String... writeAttributes)
The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an IdP, this array must include all attributes that you have mapped to IdP attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If your app client does not have write access to a mapped attribute, Amazon Cognito throws an error when it tries to update the attribute. For more information, see Specifying IdP Attribute Mappings for Your user pool.
CreateUserPoolClientRequest.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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
CreateUserPoolClientRequest.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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
CreateUserPoolClientRequest.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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
CreateUserPoolClientRequest.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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
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.
Values with ALLOW_ prefix must be used only along with 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.
If you don't specify a value for ExplicitAuthFlows, your app client activates the
ALLOW_USER_SRP_AUTH and ALLOW_CUSTOM_AUTH authentication flows.
CreateUserPoolClientRequest.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.
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.CreateUserPoolClientRequest.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.
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.CreateUserPoolClientRequest.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.
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.
CreateUserPoolClientRequest.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.
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.
CreateUserPoolClientRequest.Builder logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.CreateUserPoolClientRequest.Builder logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the IdPs.
logoutURLs - A list of allowed logout URLs for the IdPs.CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.Builder allowedOAuthFlowsWithStrings(Collection<String> allowedOAuthFlows)
The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
allowedOAuthFlows - The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
CreateUserPoolClientRequest.Builder allowedOAuthFlowsWithStrings(String... allowedOAuthFlows)
The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
allowedOAuthFlows - The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
CreateUserPoolClientRequest.Builder allowedOAuthFlows(Collection<OAuthFlowType> allowedOAuthFlows)
The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
allowedOAuthFlows - The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
CreateUserPoolClientRequest.Builder allowedOAuthFlows(OAuthFlowType... allowedOAuthFlows)
The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
allowedOAuthFlows - The allowed OAuth flows.
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.
Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
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.
CreateUserPoolClientRequest.Builder allowedOAuthScopes(Collection<String> allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
openid, and profile. Possible values provided by Amazon Web Services 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 Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also
supported.CreateUserPoolClientRequest.Builder allowedOAuthScopes(String... allowedOAuthScopes)
The allowed OAuth scopes. Possible values provided by OAuth are phone, email,
openid, and profile. Possible values provided by Amazon Web Services 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 Amazon Web Services are
aws.cognito.signin.user.admin. Custom scopes created in Resource Servers are also
supported.CreateUserPoolClientRequest.Builder allowedOAuthFlowsUserPoolClient(Boolean allowedOAuthFlowsUserPoolClient)
Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
allowedOAuthFlowsUserPoolClient - Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito
user pools.CreateUserPoolClientRequest.Builder analyticsConfiguration(AnalyticsConfigurationType analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
analyticsConfiguration - The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint
campaign. In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.
default CreateUserPoolClientRequest.Builder analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
In Amazon Web Services Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in Amazon Web Services Region us-east-1. In Regions where Amazon Pinpoint is available, user pools 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)CreateUserPoolClientRequest.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 early behavior of Amazon Cognito where user existence related
errors aren't prevented.
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 early behavior of Amazon Cognito where user existence
related errors aren't prevented.
PreventUserExistenceErrorTypes,
PreventUserExistenceErrorTypesCreateUserPoolClientRequest.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 early behavior of Amazon Cognito where user existence related
errors aren't prevented.
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 early behavior of Amazon Cognito where user existence
related errors aren't prevented.
PreventUserExistenceErrorTypes,
PreventUserExistenceErrorTypesCreateUserPoolClientRequest.Builder enableTokenRevocation(Boolean enableTokenRevocation)
Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
enableTokenRevocation - Activates or deactivates token revocation. For more information about revoking tokens, see RevokeToken.
If you don't include this parameter, token revocation is automatically activated for the new user pool client.
CreateUserPoolClientRequest.Builder enablePropagateAdditionalUserContextData(Boolean enablePropagateAdditionalUserContextData)
Activates the propagation of additional user context data. For more information about propagation of user
context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send device
fingerprint information, including source IP address, to Amazon Cognito advanced security. You can only
activate EnablePropagateAdditionalUserContextData in an app client that has a client secret.
enablePropagateAdditionalUserContextData - Activates the propagation of additional user context data. For more information about propagation of
user context data, see Adding advanced security to a user pool. If you don’t include this parameter, you can't send
device fingerprint information, including source IP address, to Amazon Cognito advanced security. You
can only activate EnablePropagateAdditionalUserContextData in an app client that has a
client secret.CreateUserPoolClientRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateUserPoolClientRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.