Package software.amazon.awscdk.services.appsync

Interface UserPoolConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserPoolConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:59.046Z")
@Stability(Stable)
public interface UserPoolConfig
extends software.amazon.jsii.JsiiSerializable

Configuration for Cognito user-pools in AppSync.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appsync.*;
 import software.amazon.awscdk.services.cognito.*;
 UserPool userPool;
 UserPoolConfig userPoolConfig = UserPoolConfig.builder()
         .userPool(userPool)
         // the properties below are optional
         .appIdClientRegex("appIdClientRegex")
         .defaultAction(UserPoolDefaultAction.ALLOW)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserPoolConfig.Builder	builder()
default String	getAppIdClientRegex()	the optional app id regex.
default UserPoolDefaultAction	getDefaultAction()	Default auth action.
IUserPool	getUserPool()	The Cognito user pool to use as identity source.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getUserPool

@Stability(Stable)
@NotNull
IUserPool getUserPool()

The Cognito user pool to use as identity source.

getAppIdClientRegex

@Stability(Stable)
@Nullable
default String getAppIdClientRegex()

the optional app id regex.

Default: - None

getDefaultAction

@Stability(Stable)
@Nullable
default UserPoolDefaultAction getDefaultAction()

Default auth action.

Default: ALLOW

builder

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

Returns:

a UserPoolConfig.Builder of UserPoolConfig