Package software.amazon.awscdk.services.cognito

Interface UserPoolClientProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolClientOptions

All Known Implementing Classes:

UserPoolClientProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:59.182Z")
@Stability(Stable)
public interface UserPoolClientProps
extends software.amazon.jsii.JsiiSerializable, UserPoolClientOptions

Properties for the UserPoolClient construct.

Example:

 UserPool importedPool;
 UserPoolClient userPoolClient = UserPoolClient.Builder.create(this, "UserPoolClient")
         .userPool(importedPool)
         .generateSecret(true)
         .build();
 // Allows you to pass the generated secret to other pieces of infrastructure
 SecretValue secret = userPoolClient.getUserPoolClientSecret();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserPoolClientProps.Builder	A builder for UserPoolClientProps
static final class	UserPoolClientProps.Jsii$Proxy	An implementation for UserPoolClientProps

Method Summary

Modifier and Type	Method	Description
static UserPoolClientProps.Builder	builder()
IUserPool	getUserPool()	The UserPool resource this client will have access to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getAccessTokenValidity, getAuthFlows, getAuthSessionValidity, getDisableOAuth, getEnablePropagateAdditionalUserContextData, getEnableTokenRevocation, getGenerateSecret, getIdTokenValidity, getOAuth, getPreventUserExistenceErrors, getReadAttributes, getRefreshTokenValidity, getSupportedIdentityProviders, getUserPoolClientName, getWriteAttributes

Method Details

getUserPool

@Stability(Stable)
@NotNull
IUserPool getUserPool()

The UserPool resource this client will have access to.

builder

@Stability(Stable)
static UserPoolClientProps.Builder builder()

Returns:

a UserPoolClientProps.Builder of UserPoolClientProps