Interface IBaseChannelNamespaceProps

the base properties for a channel namespace.

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IBaseChannelNamespaceProps

Syntax (vb)

Public Interface IBaseChannelNamespaceProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AppSync;

            AppSyncBackedDataSource appSyncBackedDataSource;
            Code code;

            var baseChannelNamespaceProps = new BaseChannelNamespaceProps {
                AuthorizationConfig = new NamespaceAuthConfig {
                    PublishAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
                    SubscribeAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY }
                },
                ChannelNamespaceName = "channelNamespaceName",
                Code = code,
                PublishHandlerConfig = new HandlerConfig {
                    DataSource = appSyncBackedDataSource,
                    Direct = false,
                    LambdaInvokeType = LambdaInvokeType.EVENT
                },
                SubscribeHandlerConfig = new HandlerConfig {
                    DataSource = appSyncBackedDataSource,
                    Direct = false,
                    LambdaInvokeType = LambdaInvokeType.EVENT
                }
            };

Synopsis

Properties

AuthorizationConfig	Authorization config for channel namespace.
ChannelNamespaceName	the name of the channel namespace.
Code	The Event Handler code.
PublishHandlerConfig	onPublish handler config.
SubscribeHandlerConfig	onSubscribe handler config.

Properties

AuthorizationConfig

Authorization config for channel namespace.

INamespaceAuthConfig? AuthorizationConfig { get; }

Property Value

INamespaceAuthConfig

Remarks

Default: - defaults to Event API default auth config

ChannelNamespaceName

the name of the channel namespace.

string? ChannelNamespaceName { get; }

Property Value

string

Remarks

Default: - the construct's id will be used

Code

The Event Handler code.

Code? Code { get; }

Property Value

Code

Remarks

Default: - no code is used

PublishHandlerConfig

onPublish handler config.

IHandlerConfig? PublishHandlerConfig { get; }

Property Value

IHandlerConfig

Remarks

Default: - no handler config

SubscribeHandlerConfig

onSubscribe handler config.

IHandlerConfig? SubscribeHandlerConfig { get; }

Property Value

IHandlerConfig

Remarks

Default: - no handler config