Class ChannelNamespaceProps

Additional property for an AppSync channel namespace for an Event API reference.

Inheritance

object

ChannelNamespaceProps

Implements

IChannelNamespaceProps

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 ChannelNamespaceProps : IChannelNamespaceProps, IBaseChannelNamespaceProps

Syntax (vb)

Public Class ChannelNamespaceProps Implements IChannelNamespaceProps, IBaseChannelNamespaceProps

Remarks

ExampleMetadata: infused

Examples

EventApi api;


            new ChannelNamespace(this, "Namespace", new ChannelNamespaceProps {
                Api = api,
                AuthorizationConfig = new NamespaceAuthConfig {
                    // Override publishing authorization to API Key
                    PublishAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
                    // Override subscribing authorization to Lambda
                    SubscribeAuthModeTypes = new [] { AppSyncAuthorizationType.LAMBDA }
                }
            });

Synopsis

Constructors

ChannelNamespaceProps()

Additional property for an AppSync channel namespace for an Event API reference.

Properties

Api	The API this channel namespace is associated with.
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

ChannelNamespaceProps()

Additional property for an AppSync channel namespace for an Event API reference.

public ChannelNamespaceProps()

Remarks

ExampleMetadata: infused

Examples

EventApi api;


            new ChannelNamespace(this, "Namespace", new ChannelNamespaceProps {
                Api = api,
                AuthorizationConfig = new NamespaceAuthConfig {
                    // Override publishing authorization to API Key
                    PublishAuthModeTypes = new [] { AppSyncAuthorizationType.API_KEY },
                    // Override subscribing authorization to Lambda
                    SubscribeAuthModeTypes = new [] { AppSyncAuthorizationType.LAMBDA }
                }
            });

Properties

Api

The API this channel namespace is associated with.

public IEventApi Api { get; set; }

Property Value

IEventApi

Remarks

ExampleMetadata: infused

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

IChannelNamespaceProps

IBaseChannelNamespaceProps