Package software.amazon.awscdk.services.ivschat

Interface CfnRoomProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRoomProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:18.421Z")
@Stability(Stable)
public interface CfnRoomProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ivschat.*;
 CfnRoomProps cfnRoomProps = CfnRoomProps.builder()
         .loggingConfigurationIdentifiers(List.of("loggingConfigurationIdentifiers"))
         .maximumMessageLength(123)
         .maximumMessageRatePerSecond(123)
         .messageReviewHandler(MessageReviewHandlerProperty.builder()
                 .fallbackResult("fallbackResult")
                 .uri("uri")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRoomProps.Builder	A builder for CfnRoomProps
static final class	CfnRoomProps.Jsii$Proxy	An implementation for CfnRoomProps

Method Summary

Modifier and Type	Method	Description
static CfnRoomProps.Builder	builder()
default List<String>	getLoggingConfigurationIdentifiers()	List of logging-configuration identifiers attached to the room.
default Number	getMaximumMessageLength()	Maximum number of characters in a single message.
default Number	getMaximumMessageRatePerSecond()	Maximum number of messages per second that can be sent to the room (by all clients).
default Object	getMessageReviewHandler()	Configuration information for optional review of messages.
default String	getName()	Room name.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLoggingConfigurationIdentifiers

@Stability(Stable)
@Nullable
default List<String> getLoggingConfigurationIdentifiers()

List of logging-configuration identifiers attached to the room.

See Also:

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

getMaximumMessageLength

@Stability(Stable)
@Nullable
default Number getMaximumMessageLength()

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 Also:

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

getMaximumMessageRatePerSecond

@Stability(Stable)
@Nullable
default Number getMaximumMessageRatePerSecond()

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

Default: - 10

See Also:

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

getMessageReviewHandler

@Stability(Stable)
@Nullable
default Object getMessageReviewHandler()

Configuration information for optional review of messages.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

Room name.

The value does not need to be unique.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnRoomProps.Builder builder()

Returns:

a CfnRoomProps.Builder of CfnRoomProps