Package 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.109.0 (build c221850)",
           date="2025-03-19T18:01:32.540Z")
@Stability(Stable)
public class CfnUserPoolClient
extends CfnResource
implements IInspectable

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.certificatemanager.*;
 Vpc vpc;
 Certificate certificate;
 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolclient.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnUserPoolClient.AnalyticsConfigurationProperty	The settings for Amazon Pinpoint analytics configuration.
static final class	CfnUserPoolClient.Builder	A fluent builder for CfnUserPoolClient.
static interface	CfnUserPoolClient.TokenValidityUnitsProperty	The units that validity times are represented in.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUserPoolClient(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUserPoolClient(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUserPoolClient(software.constructs.Construct scope, String id, CfnUserPoolClientProps props)

Method Summary

Modifier and Type	Method	Description
Number	getAccessTokenValidity()	The access token time limit.
List<String>	getAllowedOAuthFlows()	The OAuth grant types that you want your app client to generate for clients in managed login authentication.
Object	getAllowedOAuthFlowsUserPoolClient()	Set to true to use OAuth 2.0 authorization server features in your app client.
List<String>	getAllowedOAuthScopes()	The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.
Object	getAnalyticsConfiguration()	The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
String	getAttrClientId()	The ID of the app client, for example 1example23456789 .
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, or callback, URLs for managed login authentication.
protected Map<String,Object>	getCfnProperties()
String	getClientName()	A friendly name for the app client that you want to create.
String	getDefaultRedirectUri()	The default redirect URI.
Object	getEnablePropagateAdditionalUserContextData()	When true , your application can include additional UserContextData in authentication requests.
Object	getEnableTokenRevocation()	Activates or deactivates token revocation.
List<String>	getExplicitAuthFlows()	The authentication flows that you want your user pool client to support.
Object	getGenerateSecret()	When true , generates a client secret for the app client.
Number	getIdTokenValidity()	The ID token time limit.
List<String>	getLogoutUrLs()	A list of allowed logout URLs for managed login authentication.
String	getPreventUserExistenceErrors()	Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.
List<String>	getReadAttributes()	The list of user attributes that you want your app client to have read access to.
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 that validity times are represented in.
String	getUserPoolId()	The ID of the user pool where you want to create an app client.
List<String>	getWriteAttributes()	The list of user attributes that you want your app client to have write access 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 OAuth grant types that you want your app client to generate for clients in managed login authentication.
void	setAllowedOAuthFlowsUserPoolClient(Boolean value)	Set to true to use OAuth 2.0 authorization server features in your app client.
void	setAllowedOAuthFlowsUserPoolClient(IResolvable value)	Set to true to use OAuth 2.0 authorization server features in your app client.
void	setAllowedOAuthScopes(List<String> value)	The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.
void	setAnalyticsConfiguration(IResolvable value)	The user pool analytics configuration for collecting metrics and sending them to your Amazon Pinpoint campaign.
void	setAnalyticsConfiguration(CfnUserPoolClient.AnalyticsConfigurationProperty 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, or callback, URLs for managed login authentication.
void	setClientName(String value)	A friendly name for the app client that you want to create.
void	setDefaultRedirectUri(String value)	The default redirect URI.
void	setEnablePropagateAdditionalUserContextData(Boolean value)	When true , your application can include additional UserContextData in authentication requests.
void	setEnablePropagateAdditionalUserContextData(IResolvable value)	When true , your application can include additional UserContextData in authentication requests.
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)	When true , generates a client secret for the app client.
void	setGenerateSecret(IResolvable value)	When true , generates a client secret for the app client.
void	setIdTokenValidity(Number value)	The ID token time limit.
void	setLogoutUrLs(List<String> value)	A list of allowed logout URLs for managed login authentication.
void	setPreventUserExistenceErrors(String value)	Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.
void	setReadAttributes(List<String> value)	The list of user attributes that you want your app client to have read access to.
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(IResolvable value)	The units that validity times are represented in.
void	setTokenValidityUnits(CfnUserPoolClient.TokenValidityUnitsProperty value)	The units that validity times are represented in.
void	setUserPoolId(String value)	The ID of the user pool where you want to create an app client.
void	setWriteAttributes(List<String> value)	The list of user attributes that you want your app client to have write access to.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUserPoolClient

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

CfnUserPoolClient

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

CfnUserPoolClient

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

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrClientId

@Stability(Stable)
@NotNull
public String getAttrClientId()

The ID of the app client, for example 1example23456789 .

getAttrClientSecret

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

getAttrName

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getUserPoolId

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

The ID of the user pool where you want to create an app client.

setUserPoolId

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

The ID of the user pool where you want to create an app client.

getAccessTokenValidity

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

The access token time limit.

setAccessTokenValidity

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

The access token time limit.

getAllowedOAuthFlows

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

The OAuth grant types that you want your app client to generate for clients in managed login authentication.

setAllowedOAuthFlows

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

The OAuth grant types that you want your app client to generate for clients in managed login authentication.

getAllowedOAuthFlowsUserPoolClient

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

Set to true to use OAuth 2.0 authorization server features in your app client.

setAllowedOAuthFlowsUserPoolClient

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

Set to true to use OAuth 2.0 authorization server features in your app client.

setAllowedOAuthFlowsUserPoolClient

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

Set to true to use OAuth 2.0 authorization server features in your app client.

getAllowedOAuthScopes

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

The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.

setAllowedOAuthScopes

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

The OAuth, OpenID Connect (OIDC), and custom scopes that you want to permit your app client to authorize access with.

getAnalyticsConfiguration

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

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

setAnalyticsConfiguration

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

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

setAnalyticsConfiguration

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

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

getAuthSessionValidity

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

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

setAuthSessionValidity

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

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

getCallbackUrLs

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

A list of allowed redirect, or callback, URLs for managed login authentication.

setCallbackUrLs

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

A list of allowed redirect, or callback, URLs for managed login authentication.

getClientName

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

A friendly name for the app client that you want to create.

setClientName

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

A friendly name for the app client that you want to create.

getDefaultRedirectUri

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

The default redirect URI.

setDefaultRedirectUri

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

The default redirect URI.

getEnablePropagateAdditionalUserContextData

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

When true , your application can include additional UserContextData in authentication requests.

setEnablePropagateAdditionalUserContextData

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

When true , your application can include additional UserContextData in authentication requests.

setEnablePropagateAdditionalUserContextData

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

When true , your application can include additional UserContextData in authentication requests.

getEnableTokenRevocation

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

Activates or deactivates token revocation.

setEnableTokenRevocation

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

Activates or deactivates token revocation.

setEnableTokenRevocation

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

Activates or deactivates token revocation.

getExplicitAuthFlows

@Stability(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.

setExplicitAuthFlows

@Stability(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.

getGenerateSecret

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

When true , generates a client secret for the app client.

setGenerateSecret

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

When true , generates a client secret for the app client.

setGenerateSecret

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

When true , generates a client secret for the app client.

getIdTokenValidity

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

The ID token time limit.

setIdTokenValidity

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

The ID token time limit.

getLogoutUrLs

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

A list of allowed logout URLs for managed login authentication.

setLogoutUrLs

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

A list of allowed logout URLs for managed login authentication.

getPreventUserExistenceErrors

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

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.

setPreventUserExistenceErrors

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

Errors and responses that you want Amazon Cognito APIs to return during authentication, account confirmation, and password recovery when the user doesn't exist in the user pool.

getReadAttributes

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

The list of user attributes that you want your app client to have read access to.

setReadAttributes

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

The list of user attributes that you want your app client to have read access to.

getRefreshTokenValidity

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

The refresh token time limit.

setRefreshTokenValidity

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

The refresh token time limit.

getSupportedIdentityProviders

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

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

setSupportedIdentityProviders

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

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

getTokenValidityUnits

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

The units that validity times are represented in.

setTokenValidityUnits

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

The units that validity times are represented in.

setTokenValidityUnits

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

The units that validity times are represented in.

getWriteAttributes

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

The list of user attributes that you want your app client to have write access to.

setWriteAttributes

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

The list of user attributes that you want your app client to have write access to.