Struct ChannelNamespace

#[non_exhaustive]
pub struct ChannelNamespace {
    pub api_id: Option<String>,
    pub name: Option<String>,
    pub subscribe_auth_modes: Option<Vec<AuthMode>>,
    pub publish_auth_modes: Option<Vec<AuthMode>>,
    pub code_handlers: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub channel_namespace_arn: Option<String>,
    pub created: Option<DateTime>,
    pub last_modified: Option<DateTime>,
    pub handler_configs: Option<HandlerConfigs>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

api_id: Option<String>

The Api ID.

name: Option<String>

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

subscribe_auth_modes: Option<Vec<AuthMode>>

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

publish_auth_modes: Option<Vec<AuthMode>>

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

code_handlers: Option<String>

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

tags: Option<HashMap<String, String>>

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

channel_namespace_arn: Option<String>

The Amazon Resource Name (ARN) for the ChannelNamespace.

created: Option<DateTime>

The date and time that the ChannelNamespace was created.

last_modified: Option<DateTime>

The date and time that the ChannelNamespace was last changed.

handler_configs: Option<HandlerConfigs>

The configuration for the OnPublish and OnSubscribe handlers.

Implementations

impl ChannelNamespace

pub fn api_id(&self) -> Option<&str>

The Api ID.

pub fn name(&self) -> Option<&str>

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

pub fn subscribe_auth_modes(&self) -> &[AuthMode]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subscribe_auth_modes.is_none().

pub fn publish_auth_modes(&self) -> &[AuthMode]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .publish_auth_modes.is_none().

pub fn code_handlers(&self) -> Option<&str>

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

pub fn channel_namespace_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the ChannelNamespace.

pub fn created(&self) -> Option<&DateTime>

The date and time that the ChannelNamespace was created.

pub fn last_modified(&self) -> Option<&DateTime>

The date and time that the ChannelNamespace was last changed.

pub fn handler_configs(&self) -> Option<&HandlerConfigs>

The configuration for the OnPublish and OnSubscribe handlers.

impl ChannelNamespace

pub fn builder() -> ChannelNamespaceBuilder

Creates a new builder-style object to manufacture ChannelNamespace.

Trait Implementations

impl Clone for ChannelNamespace

fn clone(&self) -> ChannelNamespace

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChannelNamespace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ChannelNamespace

fn eq(&self, other: &ChannelNamespace) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ChannelNamespace