AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

ChannelNamespace

A Channel Namespace.

Import

import { ChannelNamespace } from 'aws-cdk-lib/aws-appsync';

Or use the module namespace:

import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.ChannelNamespace

Properties

Configuration passed to the constructor as ChannelNamespaceProps.

apiRequired
IEventApi

The API this channel namespace is associated with.

5 properties inherited from BaseChannelNamespaceProps
authorizationConfigOptionalinherited from BaseChannelNamespaceProps
NamespaceAuthConfig

Authorization config for channel namespace.

Default: - defaults to Event API default auth config

channelNamespaceNameOptionalinherited from BaseChannelNamespaceProps
string

the name of the channel namespace.

Default: - the construct's id will be used

codeOptionalinherited from BaseChannelNamespaceProps
Code

The Event Handler code.

Default: - no code is used

publishHandlerConfigOptionalinherited from BaseChannelNamespaceProps
HandlerConfig

onPublish handler config.

Default: - no handler config

subscribeHandlerConfigOptionalinherited from BaseChannelNamespaceProps
HandlerConfig

onSubscribe handler config.

Default: - no handler config

Get the AWS AppSync Cheat Sheet

Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.

Download Free Infographic