CfnRoomProps

class aws_cdk.aws_ivschat.CfnRoomProps(*, logging_configuration_identifiers=None, maximum_message_length=None, maximum_message_rate_per_second=None, message_review_handler=None, name=None, tags=None)

Bases: object

Properties for defining a CfnRoom.

Parameters:
  • logging_configuration_identifiers (Optional[Sequence[str]]) – List of logging-configuration identifiers attached to the room.

  • maximum_message_length (Union[int, float, None]) – 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

  • maximum_message_rate_per_second (Union[int, float, None]) – Maximum number of messages per second that can be sent to the room (by all clients). Default: - 10

  • message_review_handler (Union[IResolvable, MessageReviewHandlerProperty, Dict[str, Any], None]) – Configuration information for optional review of messages.

  • name (Optional[str]) – Room name. The value does not need to be unique.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ivschat as ivschat

cfn_room_props = ivschat.CfnRoomProps(
    logging_configuration_identifiers=["loggingConfigurationIdentifiers"],
    maximum_message_length=123,
    maximum_message_rate_per_second=123,
    message_review_handler=ivschat.CfnRoom.MessageReviewHandlerProperty(
        fallback_result="fallbackResult",
        uri="uri"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

logging_configuration_identifiers

List of logging-configuration identifiers attached to the room.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-loggingconfigurationidentifiers

maximum_message_length

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-maximummessagelength

maximum_message_rate_per_second

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

Default:
  • 10

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-maximummessageratepersecond

message_review_handler

Configuration information for optional review of messages.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-messagereviewhandler

name

Room name.

The value does not need to be unique.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-name

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html#cfn-ivschat-room-tags