@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:46.890Z")
public interface UserPoolClientOptions
Example:
UserPool pool = new UserPool(this, "Pool"); pool.addClient("app-client", UserPoolClientOptions.builder() .oAuth(OAuthSettings.builder() .flows(OAuthFlows.builder() .authorizationCodeGrant(true) .build()) .scopes(List.of(OAuthScope.OPENID)) .callbackUrls(List.of("https://my-app-domain.com/welcome")) .logoutUrls(List.of("https://my-app-domain.com/signin")) .build()) .build());
Modifier and Type | Interface and Description |
---|---|
static class |
UserPoolClientOptions.Builder
A builder for
UserPoolClientOptions |
static class |
UserPoolClientOptions.Jsii$Proxy
An implementation for
UserPoolClientOptions |
Modifier and Type | Method and Description |
---|---|
static UserPoolClientOptions.Builder |
builder() |
default Duration |
getAccessTokenValidity()
Validity of the access token.
|
default AuthFlow |
getAuthFlows()
The set of OAuth authentication flows to enable on the client.
|
default java.lang.Boolean |
getDisableOAuth()
Turns off all OAuth interactions for this client.
|
default java.lang.Boolean |
getEnableTokenRevocation()
Enable token revocation for this client.
|
default java.lang.Boolean |
getGenerateSecret()
Whether to generate a client secret.
|
default Duration |
getIdTokenValidity()
Validity of the ID token.
|
default OAuthSettings |
getOAuth()
OAuth settings for this client to interact with the app.
|
default java.lang.Boolean |
getPreventUserExistenceErrors()
Whether Cognito returns a UserNotFoundException exception when the user does not exist in the user pool (false), or whether it returns another type of error that doesn't reveal the user's absence.
|
default ClientAttributes |
getReadAttributes()
The set of attributes this client will be able to read.
|
default Duration |
getRefreshTokenValidity()
Validity of the refresh token.
|
default java.util.List<UserPoolClientIdentityProvider> |
getSupportedIdentityProviders()
The list of identity providers that users should be able to use to sign in using this client.
|
default java.lang.String |
getUserPoolClientName()
Name of the application client.
|
default ClientAttributes |
getWriteAttributes()
The set of attributes this client will be able to write.
|
default Duration getAccessTokenValidity()
Values between 5 minutes and 1 day are valid. The duration can not be longer than the refresh token validity.
Default: Duration.minutes(60)
default AuthFlow getAuthFlows()
Default: - all auth flows disabled
default java.lang.Boolean getDisableOAuth()
Default: false
default java.lang.Boolean getEnableTokenRevocation()
Default: true for new user pool clients
default java.lang.Boolean getGenerateSecret()
Default: false
default Duration getIdTokenValidity()
Values between 5 minutes and 1 day are valid. The duration can not be longer than the refresh token validity.
Default: Duration.minutes(60)
default OAuthSettings getOAuth()
An error is thrown when this is specified and disableOAuth
is set.
Default: - see defaults in `OAuthSettings`. meaningless if `disableOAuth` is set.
default java.lang.Boolean getPreventUserExistenceErrors()
Default: false
default ClientAttributes getReadAttributes()
Default: - all standard and custom attributes
default Duration getRefreshTokenValidity()
Values between 60 minutes and 10 years are valid.
Default: Duration.days(30)
default java.util.List<UserPoolClientIdentityProvider> getSupportedIdentityProviders()
Default: - supports all identity providers that are registered with the user pool. If the user pool and/or identity providers are imported, either specify this option explicitly or ensure that the identity providers are registered with the user pool using the `UserPool.registerIdentityProvider()` API.
default java.lang.String getUserPoolClientName()
Default: - cloudformation generated name
default ClientAttributes getWriteAttributes()
Default: - all standard and custom attributes
static UserPoolClientOptions.Builder builder()
UserPoolClientOptions.Builder
of UserPoolClientOptions