Skip to content
v2.273.0

CfnRoomProps Struct ​

Properties for defining a CfnRoom.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ivschat as ivschat } from 'aws-cdk-lib';
const cfnRoomProps: ivschat.CfnRoomProps = {
  loggingConfigurationIdentifiers: ['loggingConfigurationIdentifiers'],
  maximumMessageLength: 123,
  maximumMessageRatePerSecond: 123,
  messageReviewHandler: {
    fallbackResult: 'fallbackResult',
    uri: 'uri',
  },
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

loggingConfigurationIdentifiersstring | ILoggingConfigurationRef[]logging_configuration_identifierstyping.List[typing.Union[str, ILoggingConfigurationRef]]loggingConfigurationIdentifiersList<String>LoggingConfigurationIdentifiersstring[]LoggingConfigurationIdentifiers*[]interface{}#
List of logging-configuration identifiers attached to the room.
maximumMessageLengthnumbermaximum_message_lengthint | floatmaximumMessageLengthNumberMaximumMessageLengthdoubleMaximumMessageLength*float64= 500#
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.

maximumMessageRatePerSecondnumbermaximum_message_rate_per_secondint | floatmaximumMessageRatePerSecondNumberMaximumMessageRatePerSeconddoubleMaximumMessageRatePerSecond*float64= 10#
Maximum number of messages per second that can be sent to the room (by all clients).
messageReviewHandlerIResolvable | CfnRoom.MessageReviewHandlerPropertymessage_review_handlertyping.Union[IResolvable, MessageReviewHandlerProperty]messageReviewHandlerIResolvableMessageReviewHandlerIResolvableMessageReviewHandlerinterface{}#
Configuration information for optional review of messages.
namestringnamestrnameStringNamestringName*string#
Room name.

The value does not need to be unique.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
An array of key-value pairs to apply to this resource.

For more information, see Tag .

Used as props by ​