ChannelNamespace
Describes a channel namespace associated with an Api
. The ChannelNamespace
contains the definitions for code handlers for the Api
.
Contents
- apiId
-
The
Api
ID.Type: String
Required: No
- channelNamespaceArn
-
The Amazon Resource Name (ARN) for the
ChannelNamespace
.Type: String
Required: No
- codeHandlers
-
The event handler functions that run custom business logic to process published events and subscribe requests.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32768.
Required: No
- created
-
The date and time that the
ChannelNamespace
was created.Type: Timestamp
Required: No
- lastModified
-
The date and time that the
ChannelNamespace
was last changed.Type: Timestamp
Required: No
- name
-
The name of the channel namespace. This name must be unique within the
Api
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern:
([A-Za-z0-9](?:[A-Za-z0-9\-]{0,48}[A-Za-z0-9])?)
Required: No
- publishAuthModes
-
The authorization mode to use for publishing messages on the channel namespace. This configuration overrides the default
Api
authorization configuration.Type: Array of AuthMode objects
Required: No
- subscribeAuthModes
-
The authorization mode to use for subscribing to messages on the channel namespace. This configuration overrides the default
Api
authorization configuration.Type: Array of AuthMode objects
Required: No
-
A map with keys of
TagKey
objects and values ofTagValue
objects.Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[ a-zA-Z+-=._:/]+$
Value Length Constraints: Maximum length of 256.
Value Pattern:
^[\s\w+-=\.:/@]*$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: