AWS CDK Reference

Appearance

v2.274.0

ChannelNamespaceProps Struct ​

Additional property for an AppSync channel namespace for an Event API reference.

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 ​

apiIEventApiapiIEventApiapiIEventApiApiIEventApiApiIEventApirequired#
The API this channel namespace is associated with.
authorizationConfigoptionalNamespaceAuthConfigauthorization_configoptionalNamespaceAuthConfigauthorizationConfigoptionalNamespaceAuthConfigAuthorizationConfigoptionalNamespaceAuthConfigAuthorizationConfigoptionalNamespaceAuthConfig#
Authorization config for channel namespace.

Default: defaults to Event API default auth config

channelNamespaceNameoptionalstringchannel_namespace_nameoptionalstrchannelNamespaceNameoptionalStringChannelNamespaceNameoptionalstringChannelNamespaceNameoptional*string#
the name of the channel namespace.

Default: the construct's id will be used

codeoptionalCodecodeoptionalCodecodeoptionalCodeCodeoptionalCodeCodeoptionalCode#
The Event Handler code.

Default: no code is used

publishHandlerConfigoptionalHandlerConfigpublish_handler_configoptionalHandlerConfigpublishHandlerConfigoptionalHandlerConfigPublishHandlerConfigoptionalHandlerConfigPublishHandlerConfigoptionalHandlerConfig#
onPublish handler config.

Default: no handler config

subscribeHandlerConfigoptionalHandlerConfigsubscribe_handler_configoptionalHandlerConfigsubscribeHandlerConfigoptionalHandlerConfigSubscribeHandlerConfigoptionalHandlerConfigSubscribeHandlerConfigoptionalHandlerConfig#
onSubscribe handler config.

Default: no handler config