software.amazon.awscdk.services.cognito

Class CfnUserPoolClient

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolClient

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:46.255Z")
 @Stability(value=Stable)
public class CfnUserPoolClient
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Cognito::UserPoolClient`.

The AWS::Cognito::UserPoolClient resource specifies an Amazon Cognito user pool client.

If you don't specify a value for a parameter, Amazon Cognito sets it to a default value.

Example:

 import software.amazon.awscdk.services.cognito.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.elasticloadbalancingv2.*;
 import software.amazon.awscdk.App;
 import software.amazon.awscdk.CfnOutput;
 import software.amazon.awscdk.Stack;
 import constructs.Construct;
 import software.amazon.awscdk.*;
 CognitoStack extends Stack {CognitoStack(ApplicationLoadBalancer lb = ApplicationLoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .build();
 UserPool userPool = new UserPool(this, "UserPool");
 UserPoolClient userPoolClient = UserPoolClient.Builder.create(this, "Client")
         .userPool(userPool)
         // Required minimal configuration for use with an ELB
         .generateSecret(true)
         .authFlows(AuthFlow.builder()
                 .userPassword(true)
                 .build())
         .oAuth(OAuthSettings.builder()
                 .flows(OAuthFlows.builder()
                         .authorizationCodeGrant(true)
                         .build())
                 .scopes(List.of(OAuthScope.EMAIL))
                 .callbackUrls(List.of(String.format("https://%s/oauth2/idpresponse", lb.getLoadBalancerDnsName())))
                 .build())
         .build();
 CfnUserPoolClient cfnClient = (CfnUserPoolClient)userPoolClient.getNode().getDefaultChild();
 cfnClient.addPropertyOverride("RefreshTokenValidity", 1);
 cfnClient.addPropertyOverride("SupportedIdentityProviders", List.of("COGNITO"));
 UserPoolDomain userPoolDomain = UserPoolDomain.Builder.create(this, "Domain")
         .userPool(userPool)
         .cognitoDomain(CognitoDomainOptions.builder()
                 .domainPrefix("test-cdk-prefix")
                 .build())
         .build();
 lb.addListener("Listener", BaseApplicationListenerProps.builder()
         .port(443)
         .certificates(List.of(certificate))
         .defaultAction(AuthenticateCognitoAction.Builder.create()
                 .userPool(userPool)
                 .userPoolClient(userPoolClient)
                 .userPoolDomain(userPoolDomain)
                 .next(ListenerAction.fixedResponse(200, FixedResponseOptions.builder()
                         .contentType("text/plain")
                         .messageBody("Authenticated")
                         .build()))
                 .build())
         .build());
 CfnOutput.Builder.create(this, "DNS")
         .value(lb.getLoadBalancerDnsName())
         .build();
 App app = new App();
 new CognitoStack(app, "integ-cognito");
 app.synth();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnUserPoolClient.AnalyticsConfigurationProperty The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.
static class	CfnUserPoolClient.Builder A fluent builder for CfnUserPoolClient.
static interface	CfnUserPoolClient.TokenValidityUnitsProperty The units in which the validity times are represented.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUserPoolClient(software.constructs.Construct scope, String id, CfnUserPoolClientProps props) Create a new `AWS::Cognito::UserPoolClient`.
protected	CfnUserPoolClient(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolClient(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Number	getAccessTokenValidity() The time limit after which the access token is no longer valid and can't be used.
List<String>	getAllowedOAuthFlows() The allowed OAuth flows.
Object	getAllowedOAuthFlowsUserPoolClient() Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
List<String>	getAllowedOAuthScopes() The allowed OAuth scopes.
Object	getAnalyticsConfiguration() The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
String	getAttrClientSecret()
String	getAttrName()
List<String>	getCallbackUrLs() A list of allowed redirect (callback) URLs for the identity providers.
protected Map<String,Object>	getCfnProperties()
String	getClientName() The client name for the user pool client you would like to create.
String	getDefaultRedirectUri() The default redirect URI.
Object	getEnableTokenRevocation() Activates or deactivates token revocation.
List<String>	getExplicitAuthFlows() The authentication flows that are supported by the user pool clients.
Object	getGenerateSecret() Boolean to specify whether you want to generate a secret for the user pool client being created.
Number	getIdTokenValidity() The time limit after which the access token is no longer valid and can't be used.
List<String>	getLogoutUrLs() A list of allowed logout URLs for the identity providers.
String	getPreventUserExistenceErrors() 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.
List<String>	getReadAttributes() The read attributes.
Number	getRefreshTokenValidity() The time limit after which the refresh token is no longer valid and can't be used.
List<String>	getSupportedIdentityProviders() A list of provider names for the identity providers that are supported on this client.
Object	getTokenValidityUnits() The units in which the validity times are represented.
String	getUserPoolId() The user pool ID for the user pool where you want to create a user pool client.
List<String>	getWriteAttributes() The user pool attributes that the app client can write to.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccessTokenValidity(Number value) The time limit after which the access token is no longer valid and can't be used.
void	setAllowedOAuthFlows(List<String> value) The allowed OAuth flows.
void	setAllowedOAuthFlowsUserPoolClient(Boolean value) Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
void	setAllowedOAuthFlowsUserPoolClient(IResolvable value) Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.
void	setAllowedOAuthScopes(List<String> value) The allowed OAuth scopes.
void	setAnalyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty value) The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
void	setAnalyticsConfiguration(IResolvable value) The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
void	setCallbackUrLs(List<String> value) A list of allowed redirect (callback) URLs for the identity providers.
void	setClientName(String value) The client name for the user pool client you would like to create.
void	setDefaultRedirectUri(String value) The default redirect URI.
void	setEnableTokenRevocation(Boolean value) Activates or deactivates token revocation.
void	setEnableTokenRevocation(IResolvable value) Activates or deactivates token revocation.
void	setExplicitAuthFlows(List<String> value) The authentication flows that are supported by the user pool clients.
void	setGenerateSecret(Boolean value) Boolean to specify whether you want to generate a secret for the user pool client being created.
void	setGenerateSecret(IResolvable value) Boolean to specify whether you want to generate a secret for the user pool client being created.
void	setIdTokenValidity(Number value) The time limit after which the access token is no longer valid and can't be used.
void	setLogoutUrLs(List<String> value) A list of allowed logout URLs for the identity providers.
void	setPreventUserExistenceErrors(String value) 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.
void	setReadAttributes(List<String> value) The read attributes.
void	setRefreshTokenValidity(Number value) The time limit after which the refresh token is no longer valid and can't be used.
void	setSupportedIdentityProviders(List<String> value) A list of provider names for the identity providers that are supported on this client.
void	setTokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty value) The units in which the validity times are represented.
void	setTokenValidityUnits(IResolvable value) The units in which the validity times are represented.
void	setUserPoolId(String value) The user pool ID for the user pool where you want to create a user pool client.
void	setWriteAttributes(List<String> value) The user pool attributes that the app client can write to.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUserPoolClient

protected CfnUserPoolClient(software.amazon.jsii.JsiiObjectRef objRef)

CfnUserPoolClient

protected CfnUserPoolClient(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUserPoolClient

@Stability(value=Stable)
public CfnUserPoolClient(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  CfnUserPoolClientProps props)

Create a new `AWS::Cognito::UserPoolClient`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrClientSecret

@Stability(value=Stable)
 @NotNull
public String getAttrClientSecret()

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUserPoolId

@Stability(value=Stable)
 @NotNull
public String getUserPoolId()

The user pool ID for the user pool where you want to create a user pool client.

setUserPoolId

@Stability(value=Stable)
public void setUserPoolId(@NotNull
                                                   String value)

The user pool ID for the user pool where you want to create a user pool client.

getAccessTokenValidity

@Stability(value=Stable)
 @Nullable
public Number getAccessTokenValidity()

The time limit after which the access token is no longer valid and can't be used.

If you supply a TokenValidityUnits value, you override the default time unit of hours . The default time unit for AccessTokenValidity in an API request is hours.

setAccessTokenValidity

@Stability(value=Stable)
public void setAccessTokenValidity(@Nullable
                                                            Number value)

The time limit after which the access token is no longer valid and can't be used.

If you supply a TokenValidityUnits value, you override the default time unit of hours . The default time unit for AccessTokenValidity in an API request is hours.

getAllowedOAuthFlows

@Stability(value=Stable)
 @Nullable
public List<String> getAllowedOAuthFlows()

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.

setAllowedOAuthFlows

@Stability(value=Stable)
public void setAllowedOAuthFlows(@Nullable
                                                          List<String> value)

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.

getAllowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
 @Nullable
public Object getAllowedOAuthFlowsUserPoolClient()

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

setAllowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
public void setAllowedOAuthFlowsUserPoolClient(@Nullable
                                                                        Boolean value)

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

setAllowedOAuthFlowsUserPoolClient

@Stability(value=Stable)
public void setAllowedOAuthFlowsUserPoolClient(@Nullable
                                                                        IResolvable value)

Set to true if the client is allowed to follow the OAuth protocol when interacting with Amazon Cognito user pools.

getAllowedOAuthScopes

@Stability(value=Stable)
 @Nullable
public List<String> getAllowedOAuthScopes()

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.

setAllowedOAuthScopes

@Stability(value=Stable)
public void setAllowedOAuthScopes(@Nullable
                                                           List<String> value)

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.

getAnalyticsConfiguration

@Stability(value=Stable)
 @Nullable
public Object getAnalyticsConfiguration()

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

setAnalyticsConfiguration

@Stability(value=Stable)
public void setAnalyticsConfiguration(@Nullable
                                                               CfnUserPoolClient.AnalyticsConfigurationProperty value)

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

setAnalyticsConfiguration

@Stability(value=Stable)
public void setAnalyticsConfiguration(@Nullable
                                                               IResolvable value)

The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.

In AWS Regions where Amazon Pinpoint isn't available, user pools only support sending events to Amazon Pinpoint projects in AWS Region us-east-1. In Regions where Amazon Pinpoint is available, user pools support sending events to Amazon Pinpoint projects within that same Region.

getCallbackUrLs

@Stability(value=Stable)
 @Nullable
public List<String> getCallbackUrLs()

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.

setCallbackUrLs

@Stability(value=Stable)
public void setCallbackUrLs(@Nullable
                                                     List<String> value)

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.

getClientName

@Stability(value=Stable)
 @Nullable
public String getClientName()

The client name for the user pool client you would like to create.

setClientName

@Stability(value=Stable)
public void setClientName(@Nullable
                                                   String value)

The client name for the user pool client you would like to create.

getDefaultRedirectUri

@Stability(value=Stable)
 @Nullable
public String getDefaultRedirectUri()

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.

setDefaultRedirectUri

@Stability(value=Stable)
public void setDefaultRedirectUri(@Nullable
                                                           String value)

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.

getEnableTokenRevocation

@Stability(value=Stable)
 @Nullable
public Object getEnableTokenRevocation()

Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

setEnableTokenRevocation

@Stability(value=Stable)
public void setEnableTokenRevocation(@Nullable
                                                              Boolean value)

Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

setEnableTokenRevocation

@Stability(value=Stable)
public void setEnableTokenRevocation(@Nullable
                                                              IResolvable value)

Activates or deactivates token revocation. For more information about revoking tokens, see [RevokeToken](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_RevokeToken.html) .

If you don't include this parameter, token revocation is automatically activated for the new user pool client.

getExplicitAuthFlows

@Stability(value=Stable)
 @Nullable
public List<String> getExplicitAuthFlows()

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 AWS 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.

setExplicitAuthFlows

@Stability(value=Stable)
public void setExplicitAuthFlows(@Nullable
                                                          List<String> value)

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 AWS 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.

getGenerateSecret

@Stability(value=Stable)
 @Nullable
public Object getGenerateSecret()

Boolean to specify whether you want to generate a secret for the user pool client being created.

setGenerateSecret

@Stability(value=Stable)
public void setGenerateSecret(@Nullable
                                                       Boolean value)

Boolean to specify whether you want to generate a secret for the user pool client being created.

setGenerateSecret

@Stability(value=Stable)
public void setGenerateSecret(@Nullable
                                                       IResolvable value)

Boolean to specify whether you want to generate a secret for the user pool client being created.

getIdTokenValidity

@Stability(value=Stable)
 @Nullable
public Number getIdTokenValidity()

The time limit after which the access token is no longer valid and can't be used.

If you supply a TokenValidityUnits value, you override the default time unit of hours . The default time unit for AccessTokenValidity in an API request is hours.

setIdTokenValidity

@Stability(value=Stable)
public void setIdTokenValidity(@Nullable
                                                        Number value)

The time limit after which the access token is no longer valid and can't be used.

If you supply a TokenValidityUnits value, you override the default time unit of hours . The default time unit for AccessTokenValidity in an API request is hours.

getLogoutUrLs

@Stability(value=Stable)
 @Nullable
public List<String> getLogoutUrLs()

A list of allowed logout URLs for the identity providers.

setLogoutUrLs

@Stability(value=Stable)
public void setLogoutUrLs(@Nullable
                                                   List<String> value)

A list of allowed logout URLs for the identity providers.

getPreventUserExistenceErrors

@Stability(value=Stable)
 @Nullable
public String getPreventUserExistenceErrors()

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.

setPreventUserExistenceErrors

@Stability(value=Stable)
public void setPreventUserExistenceErrors(@Nullable
                                                                   String value)

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.

getReadAttributes

@Stability(value=Stable)
 @Nullable
public List<String> getReadAttributes()

The read attributes.

setReadAttributes

@Stability(value=Stable)
public void setReadAttributes(@Nullable
                                                       List<String> value)

The read attributes.

getRefreshTokenValidity

@Stability(value=Stable)
 @Nullable
public Number getRefreshTokenValidity()

The time limit after which the refresh token is no longer valid and can't be used.

The default time unit for RefreshTokenValidity in an API request is days.

setRefreshTokenValidity

@Stability(value=Stable)
public void setRefreshTokenValidity(@Nullable
                                                             Number value)

The time limit after which the refresh token is no longer valid and can't be used.

The default time unit for RefreshTokenValidity in an API request is days.

getSupportedIdentityProviders

@Stability(value=Stable)
 @Nullable
public List<String> getSupportedIdentityProviders()

A list of provider names for the identity providers that are supported on this client.

The following are supported: COGNITO , Facebook , SignInWithApple , Google and LoginWithAmazon .

setSupportedIdentityProviders

@Stability(value=Stable)
public void setSupportedIdentityProviders(@Nullable
                                                                   List<String> value)

A list of provider names for the identity providers that are supported on this client.

The following are supported: COGNITO , Facebook , SignInWithApple , Google and LoginWithAmazon .

getTokenValidityUnits

@Stability(value=Stable)
 @Nullable
public Object getTokenValidityUnits()

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.

setTokenValidityUnits

@Stability(value=Stable)
public void setTokenValidityUnits(@Nullable
                                                           CfnUserPoolClient.TokenValidityUnitsProperty value)

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.

setTokenValidityUnits

@Stability(value=Stable)
public void setTokenValidityUnits(@Nullable
                                                           IResolvable value)

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.

getWriteAttributes

@Stability(value=Stable)
 @Nullable
public List<String> getWriteAttributes()

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 you have 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 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 Identity Provider Attribute Mappings for Your user pool .

setWriteAttributes

@Stability(value=Stable)
public void setWriteAttributes(@Nullable
                                                        List<String> value)

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 you have 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 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 Identity Provider Attribute Mappings for Your user pool .