Package software.amazon.awscdk.services.appsync

Interface AppSyncCognitoConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AppSyncCognitoConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:26.346Z")
@Stability(Stable)
public interface AppSyncCognitoConfig
extends software.amazon.jsii.JsiiSerializable

Configuration for Cognito user-pools in AppSync for Api.

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;
 AppSyncCognitoConfig appSyncCognitoConfig = AppSyncCognitoConfig.builder()
         .userPool(userPool)
         // the properties below are optional
         .appIdClientRegex("appIdClientRegex")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AppSyncCognitoConfig.Builder	builder()
default String	getAppIdClientRegex()	the optional app id regex.
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

builder

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

Returns:

a AppSyncCognitoConfig.Builder of AppSyncCognitoConfig