Class BaseChannelNamespaceProps

the base properties for a channel namespace.

Inheritance

object

BaseChannelNamespaceProps

Implements

IBaseChannelNamespaceProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class BaseChannelNamespaceProps : IBaseChannelNamespaceProps

Syntax (vb)

Public Class BaseChannelNamespaceProps Implements 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

Constructors

BaseChannelNamespaceProps()

the base properties for a channel namespace.

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.

Constructors

BaseChannelNamespaceProps()

the base properties for a channel namespace.

public BaseChannelNamespaceProps()

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
                }
            };

Properties

AuthorizationConfig

Authorization config for channel namespace.

public INamespaceAuthConfig? AuthorizationConfig { get; set; }

Property Value

INamespaceAuthConfig

Remarks

Default: - defaults to Event API default auth config

ChannelNamespaceName

the name of the channel namespace.

public string? ChannelNamespaceName { get; set; }

Property Value

string

Remarks

Default: - the construct's id will be used

Code

The Event Handler code.

public Code? Code { get; set; }

Property Value

Code

Remarks

Default: - no code is used

PublishHandlerConfig

onPublish handler config.

public IHandlerConfig? PublishHandlerConfig { get; set; }

Property Value

IHandlerConfig

Remarks

Default: - no handler config

SubscribeHandlerConfig

onSubscribe handler config.

public IHandlerConfig? SubscribeHandlerConfig { get; set; }

Property Value

IHandlerConfig

Remarks

Default: - no handler config

Implements

IBaseChannelNamespaceProps