Class: Aws::Ivschat::Types::CreateRoomRequest

Inherits:

Struct

• Object
• Struct
• Aws::Ivschat::Types::CreateRoomRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ivschat/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #logging_configuration_identifiers ⇒ Array<String>

  Array of logging-configuration identifiers attached to the room.

• #maximum_message_length ⇒ Integer

  Maximum number of characters in a single message.

• #maximum_message_rate_per_second ⇒ Integer

  Maximum number of messages per second that can be sent to the room (by all clients).

• #message_review_handler ⇒ Types::MessageReviewHandler

  Configuration information for optional review of messages.

• #name ⇒ String

  Room name.

• #tags ⇒ Hash<String,String>

  Tags to attach to the resource.

Instance Attribute Details

#logging_configuration_identifiers ⇒ Array<String>

Array of logging-configuration identifiers attached to the room.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ivschat/types.rb', line 250

class CreateRoomRequest < Struct.new(
  :name,
  :maximum_message_rate_per_second,
  :maximum_message_length,
  :message_review_handler,
  :tags,
  :logging_configuration_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_message_length ⇒ Integer

Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

Returns:

• (Integer)

# File 'lib/aws-sdk-ivschat/types.rb', line 250

class CreateRoomRequest < Struct.new(
  :name,
  :maximum_message_rate_per_second,
  :maximum_message_length,
  :message_review_handler,
  :tags,
  :logging_configuration_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_message_rate_per_second ⇒ Integer

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

Returns:

• (Integer)

# File 'lib/aws-sdk-ivschat/types.rb', line 250

class CreateRoomRequest < Struct.new(
  :name,
  :maximum_message_rate_per_second,
  :maximum_message_length,
  :message_review_handler,
  :tags,
  :logging_configuration_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#message_review_handler ⇒ Types::MessageReviewHandler

Configuration information for optional review of messages.

Returns:

• (Types::MessageReviewHandler)

# File 'lib/aws-sdk-ivschat/types.rb', line 250

class CreateRoomRequest < Struct.new(
  :name,
  :maximum_message_rate_per_second,
  :maximum_message_length,
  :message_review_handler,
  :tags,
  :logging_configuration_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Room name. The value does not need to be unique.

Returns:

• (String)

# File 'lib/aws-sdk-ivschat/types.rb', line 250

class CreateRoomRequest < Struct.new(
  :name,
  :maximum_message_rate_per_second,
  :maximum_message_length,
  :message_review_handler,
  :tags,
  :logging_configuration_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags to attach to the resource. Array of maps, each of the form ‘string:string (key:value)`. See [Best practices and strategies] in *Tagging Amazon Web Services Resources and Tag Editor* for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS Chat has no constraints beyond what is documented there.

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-ivschat/types.rb', line 250

class CreateRoomRequest < Struct.new(
  :name,
  :maximum_message_rate_per_second,
  :maximum_message_length,
  :message_review_handler,
  :tags,
  :logging_configuration_identifiers)
  SENSITIVE = []
  include Aws::Structure
end