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 time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be
used.
|
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 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 Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
|
default CreateUserPoolClientRequest.Builder |
analyticsConfiguration(Consumer<AnalyticsConfigurationType.Builder> analyticsConfiguration)
The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
|
CreateUserPoolClientRequest.Builder |
callbackURLs(Collection<String> callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
CreateUserPoolClientRequest.Builder |
callbackURLs(String... callbackURLs)
A list of allowed redirect (callback) URLs for the identity providers.
|
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 |
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 time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used.
|
CreateUserPoolClientRequest.Builder |
logoutURLs(Collection<String> logoutURLs)
A list of allowed logout URLs for the identity providers.
|
CreateUserPoolClientRequest.Builder |
logoutURLs(String... logoutURLs)
A list of allowed logout URLs for the identity providers.
|
CreateUserPoolClientRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateUserPoolClientRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateUserPoolClientRequest.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.
|
CreateUserPoolClientRequest.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.
|
CreateUserPoolClientRequest.Builder |
readAttributes(Collection<String> readAttributes)
The read attributes.
|
CreateUserPoolClientRequest.Builder |
readAttributes(String... readAttributes)
The read attributes.
|
CreateUserPoolClientRequest.Builder |
refreshTokenValidity(Integer refreshTokenValidity)
The time limit, in days, after which the refresh token is no longer valid and cannot be used.
|
CreateUserPoolClientRequest.Builder |
supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
CreateUserPoolClientRequest.Builder |
supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client.
|
default CreateUserPoolClientRequest.Builder |
tokenValidityUnits(Consumer<TokenValidityUnitsType.Builder> tokenValidityUnits)
The units in which the validity times are represented in.
|
CreateUserPoolClientRequest.Builder |
tokenValidityUnits(TokenValidityUnitsType tokenValidityUnits)
The units in which the validity times are represented in.
|
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 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.CreateUserPoolClientRequest.Builder accessTokenValidity(Integer accessTokenValidity)
The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
accessTokenValidity - The time limit, between 5 minutes and 1 day, after which the access token is no longer valid and
cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.CreateUserPoolClientRequest.Builder idTokenValidity(Integer idTokenValidity)
The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be used. This value will be overridden if you have entered a value in TokenValidityUnits.
idTokenValidity - The time limit, between 5 minutes and 1 day, after which the ID token is no longer valid and cannot be
used. This value will be overridden if you have entered a value in TokenValidityUnits.CreateUserPoolClientRequest.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 CreateUserPoolClientRequest.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)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 identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
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 identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
writeAttributes - The user pool attributes that the app client can write to.
If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.Builder supportedIdentityProviders(Collection<String> supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client. The following are
supported: COGNITO, Facebook, Google and LoginWithAmazon.
supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client. The following
are supported: COGNITO, Facebook, Google and
LoginWithAmazon.CreateUserPoolClientRequest.Builder supportedIdentityProviders(String... supportedIdentityProviders)
A list of provider names for the identity providers that are supported on this client. The following are
supported: COGNITO, Facebook, Google and LoginWithAmazon.
supportedIdentityProviders - A list of provider names for the identity providers that are supported on this client. The following
are supported: COGNITO, Facebook, Google and
LoginWithAmazon.CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.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.CreateUserPoolClientRequest.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.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.
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.
CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.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.
CreateUserPoolClientRequest.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.
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 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.CreateUserPoolClientRequest.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.CreateUserPoolClientRequest.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.CreateUserPoolClientRequest.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 CreateUserPoolClientRequest.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)CreateUserPoolClientRequest.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,
PreventUserExistenceErrorTypesCreateUserPoolClientRequest.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,
PreventUserExistenceErrorTypesCreateUserPoolClientRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateUserPoolClientRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.