Class: Aws::AppSync::Types::ChannelNamespace

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::ChannelNamespace

Defined in:

gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_id ⇒ String

  The Api ID.

• #channel_namespace_arn ⇒ String

  The Amazon Resource Name (ARN) for the ChannelNamespace.

• #code_handlers ⇒ String

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

• #created ⇒ Time

  The date and time that the ChannelNamespace was created.

• #handler_configs ⇒ Types::HandlerConfigs

  The configuration for the OnPublish and OnSubscribe handlers.

• #last_modified ⇒ Time

  The date and time that the ChannelNamespace was last changed.

• #name ⇒ String

  The name of the channel namespace.

• #publish_auth_modes ⇒ Array<Types::AuthMode>

  The authorization mode to use for publishing messages on the channel namespace.

• #subscribe_auth_modes ⇒ Array<Types::AuthMode>

  The authorization mode to use for subscribing to messages on the channel namespace.

• #tags ⇒ Hash<String,String>

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

Instance Attribute Details

#api_id ⇒ String

The Api ID.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#channel_namespace_arn ⇒ String

The Amazon Resource Name (ARN) for the ChannelNamespace.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#code_handlers ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#created ⇒ Time

The date and time that the ChannelNamespace was created.

Returns:

• (Time)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#handler_configs ⇒ Types::HandlerConfigs

The configuration for the OnPublish and OnSubscribe handlers.

Returns:

• (Types::HandlerConfigs)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ Time

The date and time that the ChannelNamespace was last changed.

Returns:

• (Time)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#publish_auth_modes ⇒ Array<Types::AuthMode>

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

Returns:

• (Array<Types::AuthMode>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#subscribe_auth_modes ⇒ Array<Types::AuthMode>

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

Returns:

• (Array<Types::AuthMode>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 755

class ChannelNamespace < Struct.new(
  :api_id,
  :name,
  :subscribe_auth_modes,
  :publish_auth_modes,
  :code_handlers,
  :tags,
  :channel_namespace_arn,
  :created,
  :last_modified,
  :handler_configs)
  SENSITIVE = []
  include Aws::Structure
end