appsync/aws.sdk.kotlin.services.appsync.model/ChannelNamespace

ChannelNamespace

class ChannelNamespace

Describes a channel namespace associated with an Api. The ChannelNamespace contains the definitions for code handlers for the Api.

Types

object Companion

Properties

val apiId: String?

The Api ID.

channelNamespaceArn

val channelNamespaceArn: String?

The Amazon Resource Name (ARN) for the ChannelNamespace.

val codeHandlers: String?

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

val created: Instant?

The date and time that the ChannelNamespace was created.

val handlerConfigs: HandlerConfigs?

The configuration for the OnPublish and OnSubscribe handlers.

val lastModified: Instant?

The date and time that the ChannelNamespace was last changed.

val name: String?

The name of the channel namespace. This name must be unique within the Api.

publishAuthModes

val publishAuthModes: List<AuthMode>?

The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

subscribeAuthModes

val subscribeAuthModes: List<AuthMode>?

The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default Apiauthorization configuration.

val tags: Map<String, String>?

A map with keys of TagKey objects and values of TagValue objects.

Functions

inline fun copy(block: ChannelNamespace.Builder.() -> Unit = {}): ChannelNamespace

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String