Interface UserPoolConfig
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
UserPoolConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-06T22:15:49.773Z")
@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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forUserPoolConfig
static final class
An implementation forUserPoolConfig
-
Method Summary
Modifier and TypeMethodDescriptionstatic UserPoolConfig.Builder
builder()
default String
the optional app id regex.default UserPoolDefaultAction
Default auth action.The Cognito user pool to use as identity source.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getUserPool
The Cognito user pool to use as identity source. -
getAppIdClientRegex
the optional app id regex.Default: - None
-
getDefaultAction
Default auth action.Default: ALLOW
-
builder
- Returns:
- a
UserPoolConfig.Builder
ofUserPoolConfig
-