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