Class: Aws::ChimeSDKMessaging::Types::Channel

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb

Overview

The details of a channel.

See Also:

Constant Summary collapse

SENSITIVE = 
[:name, :metadata]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_arn ⇒ String

The ARN of a channel.

Returns:

  • (String) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#channel_flow_arn ⇒ String

The ARN of the channel flow.

Returns:

  • (String) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#created_by ⇒ Types::Identity

The AppInstanceUser who created the channel.

Returns:



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#created_timestamp ⇒ Time

The time at which the AppInstanceUser created the channel.

Returns:

  • (Time) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#elastic_channel_configuration ⇒ Types::ElasticChannelConfiguration

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

Returns:



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#expiration_settings ⇒ Types::ExpirationSettings

Settings that control when a channel expires.

Returns:



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#last_message_timestamp ⇒ Time

The time at which a member sent the last message in the channel.

Returns:

  • (Time) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#last_updated_timestamp ⇒ Time

The time at which a channel was last updated.

Returns:

  • (Time) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#metadata ⇒ String

The channel's metadata.

Returns:

  • (String) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#mode ⇒ String

The mode of the channel.

Returns:

  • (String) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#name ⇒ String

The name of a channel.

Returns:

  • (String) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end

#privacy ⇒ String

The channel's privacy setting.

Returns:

  • (String) 


253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 253

class Channel < Struct.new(
  :name,
  :channel_arn,
  :mode,
  :privacy,
  :metadata,
  :created_by,
  :created_timestamp,
  :last_message_timestamp,
  :last_updated_timestamp,
  :channel_flow_arn,
  :elastic_channel_configuration,
  :expiration_settings)
  SENSITIVE = [:name, :metadata]
  include Aws::Structure
end