software.amazon.awscdk.services.cognito

Class CfnUserPoolClient

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.cognito.CfnUserPoolClient

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.513Z")
 @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.core.App;
 import software.amazon.awscdk.core.CfnOutput;
 import software.amazon.awscdk.core.Stack;
 import software.constructs.Construct;
 import software.amazon.awscdk.services.elasticloadbalancingv2.actions.*;
 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 necessary to collect 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.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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(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 access token time limit.
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()
Number	getAuthSessionValidity() Amazon Cognito creates a session token for each API request in an authentication flow.
List<String>	getCallbackUrLs() A list of allowed redirect (callback) URLs for the IdPs.
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	getEnablePropagateAdditionalUserContextData() Activates the propagation of additional user context data.
Object	getEnableTokenRevocation() Activates or deactivates token revocation.
List<String>	getExplicitAuthFlows() The authentication flows that you want your user pool client to support.
Object	getGenerateSecret() Boolean to specify whether you want to generate a secret for the user pool client being created.
Number	getIdTokenValidity() The ID token time limit.
List<String>	getLogoutUrLs() A list of allowed logout URLs for the IdPs.
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 refresh token time limit.
List<String>	getSupportedIdentityProviders() A list of provider names for the identity providers (IdPs) 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 access token time limit.
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	setAuthSessionValidity(Number value) Amazon Cognito creates a session token for each API request in an authentication flow.
void	setCallbackUrLs(List<String> value) A list of allowed redirect (callback) URLs for the IdPs.
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	setEnablePropagateAdditionalUserContextData(Boolean value) Activates the propagation of additional user context data.
void	setEnablePropagateAdditionalUserContextData(IResolvable value) Activates the propagation of additional user context data.
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 you want your user pool client to support.
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 ID token time limit.
void	setLogoutUrLs(List<String> value) A list of allowed logout URLs for the IdPs.
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 refresh token time limit.
void	setSupportedIdentityProviders(List<String> value) A list of provider names for the identity providers (IdPs) 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.core.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.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

setAccessTokenValidity

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

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.

getAllowedOAuthFlows

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

The allowed OAuth flows.

• code - 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.
• implicit - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
• client_credentials - 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.

setAllowedOAuthFlows

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

The allowed OAuth flows.

• code - 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.
• implicit - Issue the access token (and, optionally, ID token, based on scopes) directly to your user.
• client_credentials - 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.

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

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.

getAuthSessionValidity

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

Amazon Cognito creates a session token for each API request in an authentication flow.

AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

setAuthSessionValidity

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

Amazon Cognito creates a session token for each API request in an authentication flow.

AuthSessionValidity is the duration, in minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.

getCallbackUrLs

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

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.

setCallbackUrLs

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

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.

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.

getEnablePropagateAdditionalUserContextData

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

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.

setEnablePropagateAdditionalUserContextData

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

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.

setEnablePropagateAdditionalUserContextData

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

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.

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 you want your user pool client to support.

For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows , your user client supports ALLOW_REFRESH_TOKEN_AUTH , ALLOW_USER_SRP_AUTH , and ALLOW_CUSTOM_AUTH .

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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
• 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.

In some environments, you will see the values ADMIN_NO_SRP_AUTH , CUSTOM_AUTH_FLOW_ONLY , or USER_PASSWORD_AUTH . You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_ , like ALLOW_USER_SRP_AUTH .

setExplicitAuthFlows

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

The authentication flows that you want your user pool client to support.

For each app client in your user pool, you can sign in your users with any combination of one or more flows, including with a user name and Secure Remote Password (SRP), a user name and password, or a custom authentication process that you define with Lambda functions.

If you don't specify a value for ExplicitAuthFlows , your user client supports ALLOW_REFRESH_TOKEN_AUTH , ALLOW_USER_SRP_AUTH , and ALLOW_CUSTOM_AUTH .

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, your app passes a user name and password to Amazon Cognito in the request, instead of using the Secure Remote Password (SRP) protocol to securely transmit the password.
• 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.

In some environments, you will see the values ADMIN_NO_SRP_AUTH , CUSTOM_AUTH_FLOW_ONLY , or USER_PASSWORD_AUTH . You can't assign these legacy ExplicitAuthFlows values to user pool clients at the same time as values that begin with ALLOW_ , like ALLOW_USER_SRP_AUTH .

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

setIdTokenValidity

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

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.

getLogoutUrLs

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

A list of allowed logout URLs for the IdPs.

setLogoutUrLs

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

A list of allowed logout URLs for the IdPs.

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

setRefreshTokenValidity

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

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.

getSupportedIdentityProviders

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

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

The following are supported: COGNITO , Facebook , Google , SignInWithApple , and LoginWithAmazon . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP .

setSupportedIdentityProviders

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

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

The following are supported: COGNITO , Facebook , Google , SignInWithApple , and LoginWithAmazon . You can also specify the names that you configured for the SAML and OIDC IdPs in your user pool, for example MySAMLIdP or MyOIDCIdP .

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

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.

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

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