AWS CDK Reference

Appearance

v2.275.0

EventApiAuthConfig Struct ​

Authorization configuration for the Event API.

Source
aws-appsync/lib/eventapi.ts
Type last changed
v2.178.0 · 6 Feb 2025

Example ​

ts
import * as logs from 'aws-cdk-lib/aws-logs';

const apiKeyProvider: appsync.AppSyncAuthProvider = {
  authorizationType: appsync.AppSyncAuthorizationType.API_KEY,
};

const api = new appsync.EventApi(this, 'api', {
  apiName: 'Api',
  ownerContact: 'OwnerContact',
  authorizationConfig: {
    authProviders: [
      apiKeyProvider,
    ],
    connectionAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultPublishAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
    defaultSubscribeAuthModeTypes: [
      appsync.AppSyncAuthorizationType.API_KEY,
    ],
  },
  logConfig: {
    fieldLogLevel: appsync.AppSyncFieldLogLevel.INFO,
    retention: logs.RetentionDays.ONE_WEEK,
  },
});

api.addChannelNamespace('default');

Properties ​

authProvidersoptionalAppSyncAuthProvider[]auth_providersoptionaltyping.List[AppSyncAuthProvider]authProvidersoptionalList<AppSyncAuthProvider>AuthProvidersoptionalAppSyncAuthProvider[]AuthProvidersoptional*[]AppSyncAuthProvider#
Auth providers for use in connection, publish, and subscribe operations.

Default: API Key authorization

connectionAuthModeTypesoptionalAppSyncAuthorizationType[]connection_auth_mode_typesoptionaltyping.List[AppSyncAuthorizationType]connectionAuthModeTypesoptionalList<AppSyncAuthorizationType>ConnectionAuthModeTypesoptionalAppSyncAuthorizationType[]ConnectionAuthModeTypesoptional*[]AppSyncAuthorizationType#
Connection auth modes.

Default: API Key authorization

defaultPublishAuthModeTypesoptionalAppSyncAuthorizationType[]default_publish_auth_mode_typesoptionaltyping.List[AppSyncAuthorizationType]defaultPublishAuthModeTypesoptionalList<AppSyncAuthorizationType>DefaultPublishAuthModeTypesoptionalAppSyncAuthorizationType[]DefaultPublishAuthModeTypesoptional*[]AppSyncAuthorizationType#
Default publish auth modes.

Default: API Key authorization

defaultSubscribeAuthModeTypesoptionalAppSyncAuthorizationType[]default_subscribe_auth_mode_typesoptionaltyping.List[AppSyncAuthorizationType]defaultSubscribeAuthModeTypesoptionalList<AppSyncAuthorizationType>DefaultSubscribeAuthModeTypesoptionalAppSyncAuthorizationType[]DefaultSubscribeAuthModeTypesoptional*[]AppSyncAuthorizationType#
Default subscribe auth modes.

Default: API Key authorization