interface CfnChannelNamespaceProps

Language	Type name
.NET	`Amazon.CDK.AWS.AppSync.CfnChannelNamespaceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappsync#CfnChannelNamespaceProps`
Java	`software.amazon.awscdk.services.appsync.CfnChannelNamespaceProps`
Python	`aws_cdk.aws_appsync.CfnChannelNamespaceProps`
TypeScript	`aws-cdk-lib` » `aws_appsync` » `CfnChannelNamespaceProps`

Properties for defining a CfnChannelNamespace.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appsync as appsync } from 'aws-cdk-lib';
const cfnChannelNamespaceProps: appsync.CfnChannelNamespaceProps = {
  apiId: 'apiId',
  name: 'name',

  // the properties below are optional
  codeHandlers: 'codeHandlers',
  codeS3Location: 'codeS3Location',
  handlerConfigs: {
    onPublish: {
      behavior: 'behavior',
      integration: {
        dataSourceName: 'dataSourceName',

        // the properties below are optional
        lambdaConfig: {
          invokeType: 'invokeType',
        },
      },
    },
    onSubscribe: {
      behavior: 'behavior',
      integration: {
        dataSourceName: 'dataSourceName',

        // the properties below are optional
        lambdaConfig: {
          invokeType: 'invokeType',
        },
      },
    },
  },
  publishAuthModes: [{
    authType: 'authType',
  }],
  subscribeAuthModes: [{
    authType: 'authType',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
apiId	`string`	The `Api` ID.
name	`string`	The name of the channel namespace.
codeHandlers?	`string`	The event handler functions that run custom business logic to process published events and subscribe requests.
codeS3Location?	`string`	The Amazon S3 endpoint where the code is located.
handlerConfigs?	`IResolvable` `\|` `HandlerConfigsProperty`	The configuration for the `OnPublish` and `OnSubscribe` handlers.
publishAuthModes?	`IResolvable` `\| (IResolvable` `\|` `AuthModeProperty)[]`	The authorization mode to use for publishing messages on the channel namespace.
subscribeAuthModes?	`IResolvable` `\| (IResolvable` `\|` `AuthModeProperty)[]`	The authorization mode to use for subscribing to messages on the channel namespace.
tags?	`CfnTag[]`	A set of tags (key-value pairs) for this channel namespace.

apiId

Type: string

The Api ID.

name

Type: string

The name of the channel namespace.

This name must be unique within the Api .

codeHandlers?

Type: string (optional)

The event handler functions that run custom business logic to process published events and subscribe requests.

codeS3Location?

Type: string (optional)

The Amazon S3 endpoint where the code is located.

handlerConfigs?

Type: IResolvable | HandlerConfigsProperty (optional)

The configuration for the OnPublish and OnSubscribe handlers.

publishAuthModes?

Type: IResolvable | (IResolvable | AuthModeProperty)[] (optional)

The authorization mode to use for publishing messages on the channel namespace.

This configuration overrides the default Api authorization configuration.

subscribeAuthModes?

Type: IResolvable | (IResolvable | AuthModeProperty)[] (optional)

The authorization mode to use for subscribing to messages on the channel namespace.