Package software.amazon.awscdk.services.cognito

Class UserPoolClient

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.UserPoolClient

All Implemented Interfaces:

IEnvironmentAware, IResource, IUserPoolClient, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:01.597Z")
@Stability(Stable)
public class UserPoolClient
extends Resource
implements IUserPoolClient

Define a UserPool App Client.

Example:

 UserPool pool = new UserPool(this, "Pool");
 UserPoolIdentityProviderAmazon provider = UserPoolIdentityProviderAmazon.Builder.create(this, "Amazon")
         .userPool(pool)
         .clientId("amzn-client-id")
         .clientSecret("amzn-client-secret")
         .build();
 UserPoolClient client = pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .supportedIdentityProviders(List.of(UserPoolClientIdentityProvider.AMAZON))
         .build());
 client.node.addDependency(provider);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserPoolClient.Builder	A fluent builder for UserPoolClient.

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

IResource.Jsii$Default

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

IUserPoolClient.Jsii$Default, IUserPoolClient.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static IUserPoolClient	fromUserPoolClientId(software.constructs.Construct scope, String id, String userPoolClientId)	Import a user pool client given its id.
OAuthFlows	getOAuthFlows()	The OAuth flows enabled for this client.
String	getUserPoolClientId()	Name of the application client.
String	getUserPoolClientName()	The client name that was specified via the userPoolClientName property during initialization, throws an error otherwise.
SecretValue	getUserPoolClientSecret()	The generated client secret.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

UserPoolClient

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

UserPoolClient

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

UserPoolClient

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

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromUserPoolClientId

@Stability(Stable)
@NotNull
public static IUserPoolClient fromUserPoolClientId(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String userPoolClientId)

Import a user pool client given its id.

Parameters:

scope - This parameter is required.

id - This parameter is required.

userPoolClientId - This parameter is required.

getOAuthFlows

@Stability(Stable)
@NotNull
public OAuthFlows getOAuthFlows()

The OAuth flows enabled for this client.

getUserPoolClientId

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

Name of the application client.

Specified by:

getUserPoolClientId in interface IUserPoolClient

getUserPoolClientName

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

The client name that was specified via the userPoolClientName property during initialization, throws an error otherwise.

getUserPoolClientSecret

@Stability(Stable)
@NotNull
public SecretValue getUserPoolClientSecret()

The generated client secret.

Only available if the "generateSecret" props is set to true

Specified by:

getUserPoolClientSecret in interface IUserPoolClient