Package software.amazon.awscdk.services.appsync

Interface AppSyncAuthProvider

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AppSyncAuthProvider.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:45.344Z")
@Stability(Stable)
public interface AppSyncAuthProvider
extends software.amazon.jsii.JsiiSerializable

Auth provider settings for AppSync Event APIs.

Example:

 import software.amazon.awscdk.services.logs.*;
 AppSyncAuthProvider apiKeyProvider = AppSyncAuthProvider.builder()
         .authorizationType(AppSyncAuthorizationType.API_KEY)
         .build();
 EventApi api = EventApi.Builder.create(this, "api")
         .apiName("Api")
         .ownerContact("OwnerContact")
         .authorizationConfig(EventApiAuthConfig.builder()
                 .authProviders(List.of(apiKeyProvider))
                 .connectionAuthModeTypes(List.of(AppSyncAuthorizationType.API_KEY))
                 .defaultPublishAuthModeTypes(List.of(AppSyncAuthorizationType.API_KEY))
                 .defaultSubscribeAuthModeTypes(List.of(AppSyncAuthorizationType.API_KEY))
                 .build())
         .logConfig(AppSyncLogConfig.builder()
                 .fieldLogLevel(AppSyncFieldLogLevel.INFO)
                 .retention(RetentionDays.ONE_WEEK)
                 .build())
         .build();
 api.addChannelNamespace("default");
 

See Also:

• https://docs.aws.amazon.com/appsync/latest/eventapi/configure-event-api-auth.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AppSyncAuthProvider.Builder	builder()
default AppSyncApiKeyConfig	getApiKeyConfig()	If authorizationType is AuthorizationType.API_KEY, this option can be configured.
AppSyncAuthorizationType	getAuthorizationType()	One of possible authorization types AppSync supports.
default AppSyncCognitoConfig	getCognitoConfig()	If authorizationType is AuthorizationType.USER_POOL, this option is required.
default AppSyncLambdaAuthorizerConfig	getLambdaAuthorizerConfig()	If authorizationType is AuthorizationType.LAMBDA, this option is required.
default AppSyncOpenIdConnectConfig	getOpenIdConnectConfig()	If authorizationType is AuthorizationType.OIDC, this option is required.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizationType

@Stability(Stable)
@NotNull
AppSyncAuthorizationType getAuthorizationType()

One of possible authorization types AppSync supports.

Default: - `AuthorizationType.API_KEY`

getApiKeyConfig

@Stability(Stable)
@Nullable
default AppSyncApiKeyConfig getApiKeyConfig()

If authorizationType is AuthorizationType.API_KEY, this option can be configured.

Default: - name: 'DefaultAPIKey'

getCognitoConfig

@Stability(Stable)
@Nullable
default AppSyncCognitoConfig getCognitoConfig()

If authorizationType is AuthorizationType.USER_POOL, this option is required.

Default: - none

getLambdaAuthorizerConfig

@Stability(Stable)
@Nullable
default AppSyncLambdaAuthorizerConfig getLambdaAuthorizerConfig()

If authorizationType is AuthorizationType.LAMBDA, this option is required.

Default: - none

getOpenIdConnectConfig

@Stability(Stable)
@Nullable
default AppSyncOpenIdConnectConfig getOpenIdConnectConfig()

If authorizationType is AuthorizationType.OIDC, this option is required.

Default: - none

builder

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

Returns:

a AppSyncAuthProvider.Builder of AppSyncAuthProvider