software.amazon.awscdk.services.appsync

Interface UserPoolConfig

All Known Implementing Classes:

UserPoolConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:49.179Z")
public interface UserPoolConfig

(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

Nested Classes

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

Method Summary

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

Method Detail

getUserPool

IUserPool getUserPool()

(experimental) The Cognito user pool to use as identity source.

getAppIdClientRegex

default java.lang.String getAppIdClientRegex()

(experimental) the optional app id regex.

Default: - None

getDefaultAction

default UserPoolDefaultAction getDefaultAction()

(experimental) Default auth action.

Default: ALLOW

builder

static UserPoolConfig.Builder builder()

Returns:

a UserPoolConfig.Builder of UserPoolConfig