software.amazon.awscdk.services.cognito

Class UserPoolClientOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.UserPoolClientOptions.Jsii$Proxy

All Implemented Interfaces:

UserPoolClientOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

UserPoolClientOptions

@Stability(value=Experimental)
 @Internal
public static final class UserPoolClientOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements UserPoolClientOptions

An implementation for UserPoolClientOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.UserPoolClientOptions

UserPoolClientOptions.Builder, UserPoolClientOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(AuthFlow authFlows, Boolean disableOAuth, Boolean generateSecret, OAuthSettings oAuth, Boolean preventUserExistenceErrors, List<? extends UserPoolClientIdentityProvider> supportedIdentityProviders, String userPoolClientName) Constructor that initializes the object based on literal property values passed by the UserPoolClientOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
AuthFlow	getAuthFlows() (experimental) The set of OAuth authentication flows to enable on the client.
Boolean	getDisableOAuth() (experimental) Turns off all OAuth interactions for this client.
Boolean	getGenerateSecret() (experimental) Whether to generate a client secret.
OAuthSettings	getOAuth() (experimental) OAuth settings for this to client to interact with the app.
Boolean	getPreventUserExistenceErrors() (experimental) 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.
List<UserPoolClientIdentityProvider>	getSupportedIdentityProviders() (experimental) The list of identity providers that users should be able to use to sign in using this client.
String	getUserPoolClientName() (experimental) Name of the application client.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolClientOptions

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(AuthFlow authFlows,
                     Boolean disableOAuth,
                     Boolean generateSecret,
                     OAuthSettings oAuth,
                     Boolean preventUserExistenceErrors,
                     List<? extends UserPoolClientIdentityProvider> supportedIdentityProviders,
                     String userPoolClientName)

Constructor that initializes the object based on literal property values passed by the UserPoolClientOptions.Builder.

Method Detail

getAuthFlows

public final AuthFlow getAuthFlows()

Description copied from interface: UserPoolClientOptions

(experimental) The set of OAuth authentication flows to enable on the client.

Default: - all auth flows disabled

Specified by:

getAuthFlows in interface UserPoolClientOptions

See Also:

https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html

getDisableOAuth

public final Boolean getDisableOAuth()

Description copied from interface: UserPoolClientOptions

(experimental) Turns off all OAuth interactions for this client.

Default: false

Specified by:

getDisableOAuth in interface UserPoolClientOptions

getGenerateSecret

public final Boolean getGenerateSecret()

Description copied from interface: UserPoolClientOptions

(experimental) Whether to generate a client secret.

Default: false

Specified by:

getGenerateSecret in interface UserPoolClientOptions

getOAuth

public final OAuthSettings getOAuth()

Description copied from interface: UserPoolClientOptions

(experimental) OAuth settings for this to client to interact with the app.

An error is thrown when this is specified and disableOAuth is set.

Default: - see defaults in `OAuthSettings`. meaningless if `disableOAuth` is set.

Specified by:

getOAuth in interface UserPoolClientOptions

getPreventUserExistenceErrors

public final Boolean getPreventUserExistenceErrors()

Description copied from interface: UserPoolClientOptions

(experimental) 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: true for new stacks

Specified by:

getPreventUserExistenceErrors in interface UserPoolClientOptions

See Also:

https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-managing-errors.html

getSupportedIdentityProviders

public final List<UserPoolClientIdentityProvider> getSupportedIdentityProviders()

Description copied from interface: UserPoolClientOptions

(experimental) The list of identity providers that users should be able to use to sign in using this client.

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.

Specified by:

getSupportedIdentityProviders in interface UserPoolClientOptions

getUserPoolClientName

public final String getUserPoolClientName()

Description copied from interface: UserPoolClientOptions

(experimental) Name of the application client.

Default: - cloudformation generated name

Specified by:

getUserPoolClientName in interface UserPoolClientOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object