AWS CDK Reference

Appearance

v2.274.0

NamespaceAuthConfig Struct ​

Authorization configuration for the Channel Namespace.

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

Example ​

ts
declare const api: appsync.EventApi;

new appsync.ChannelNamespace(this, 'Namespace', {
  api,
  authorizationConfig: {
    // Override publishing authorization to API Key
    publishAuthModeTypes: [appsync.AppSyncAuthorizationType.API_KEY],
    // Override subscribing authorization to Lambda
    subscribeAuthModeTypes: [appsync.AppSyncAuthorizationType.LAMBDA],
  },
});

Properties ​

publishAuthModeTypesoptionalAppSyncAuthorizationType[]publish_auth_mode_typesoptionaltyping.List[AppSyncAuthorizationType]publishAuthModeTypesoptionalList<AppSyncAuthorizationType>PublishAuthModeTypesoptionalAppSyncAuthorizationType[]PublishAuthModeTypesoptional*[]AppSyncAuthorizationType#
The publish auth modes for this Event Api.

Default: API Key authorization

subscribeAuthModeTypesoptionalAppSyncAuthorizationType[]subscribe_auth_mode_typesoptionaltyping.List[AppSyncAuthorizationType]subscribeAuthModeTypesoptionalList<AppSyncAuthorizationType>SubscribeAuthModeTypesoptionalAppSyncAuthorizationType[]SubscribeAuthModeTypesoptional*[]AppSyncAuthorizationType#
The subscribe auth modes for this Event Api.

Default: API Key authorization