AWS::AppSync::ChannelNamespaceCfnChannelNamespace
The `AWS::AppSync::ChannelNamespace` resource creates a channel namespace associated with an `Api` . The `ChannelNamespace` contains the definitions for code handlers for the `Api` .
Import
import { CfnChannelNamespace } from 'aws-cdk-lib/aws-appsync';Or use the module namespace:
import * as appsync from 'aws-cdk-lib/aws-appsync';
// appsync.CfnChannelNamespaceProperties
Configuration passed to the constructor as CfnChannelNamespaceProps.
apiIdRequiredstringThe `Api` ID.
nameRequiredstringThe name of the channel namespace. This name must be unique within the `Api` .
codeHandlersOptionalstringThe event handler functions that run custom business logic to process published events and subscribe requests.
codeS3LocationOptionalstringThe Amazon S3 endpoint where the code is located.
handlerConfigsOptionalIResolvable | HandlerConfigsPropertyThe configuration for the `OnPublish` and `OnSubscribe` handlers.
publishAuthModesOptionalIResolvable | IResolvable | AuthModeProperty[]The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.
subscribeAuthModesOptionalIResolvable | IResolvable | AuthModeProperty[]The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default `Api` authorization configuration.
tagsOptionalCfnTag[]A set of tags (key-value pairs) for this channel namespace.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Get the AWS AppSync Cheat Sheet
Everything you need to know about AWS AppSync on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
aws-appsyncAWS::AppSync::ChannelNamespace