aws-cdk-lib.aws_ivschat.CfnRoomProps

interface CfnRoomProps

LanguageType name
.NETAmazon.CDK.AWS.IVSChat.CfnRoomProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsivschat#CfnRoomProps
Javasoftware.amazon.awscdk.services.ivschat.CfnRoomProps
Pythonaws_cdk.aws_ivschat.CfnRoomProps
TypeScript aws-cdk-lib » aws_ivschat » CfnRoomProps

Properties for defining a CfnRoom.

Example

// 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

NameTypeDescription
loggingConfigurationIdentifiers?string[]List of logging-configuration identifiers attached to the room.
maximumMessageLength?numberMaximum number of characters in a single message.
maximumMessageRatePerSecond?numberMaximum number of messages per second that can be sent to the room (by all clients).
messageReviewHandler?IResolvable | MessageReviewHandlerPropertyConfiguration information for optional review of messages.
name?stringRoom name.
tags?CfnTag[]An array of key-value pairs to apply to this resource.

loggingConfigurationIdentifiers?

Type: string[] (optional)

List of logging-configuration identifiers attached to the room.


maximumMessageLength?

Type: number (optional)

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.


maximumMessageRatePerSecond?

Type: number (optional)

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


messageReviewHandler?

Type: IResolvable | MessageReviewHandlerProperty (optional)

Configuration information for optional review of messages.


name?

Type: string (optional)

Room name.

The value does not need to be unique.


tags?

Type: CfnTag[] (optional)

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

For more information, see Tag .