Package software.amazon.awscdk.services.ivschat

Class CfnRoom

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ivschat.CfnRoom
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.071Z") @Stability(Stable) public class CfnRoom extends CfnResource implements IInspectable
A CloudFormation AWS::IVSChat::Room.

The AWS::IVSChat::Room resource specifies an room that allows clients to connect and pass messages. For more information, see CreateRoom in the Amazon Interactive Video Service Chat API Reference .

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.*;
 CfnRoom cfnRoom = CfnRoom.Builder.create(this, "MyCfnRoom")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRoom

      protected CfnRoom(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRoom

      protected CfnRoom(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRoom

      @Stability(Stable) public CfnRoom(@NotNull Construct scope, @NotNull String id, @Nullable CfnRoomProps props)
      Create a new AWS::IVSChat::Room.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnRoom

      @Stability(Stable) public CfnRoom(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::IVSChat::Room.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The room ARN.

      For example: arn:aws:ivschat:us-west-2:123456789012:room/abcdABCDefgh

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The room ID.

      For example: abcdABCDefgh

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getLoggingConfigurationIdentifiers

      @Stability(Stable) @Nullable public List<String> getLoggingConfigurationIdentifiers()
      List of logging-configuration identifiers attached to the room.

    • setLoggingConfigurationIdentifiers

      @Stability(Stable) public void setLoggingConfigurationIdentifiers(@Nullable List<String> value)
      List of logging-configuration identifiers attached to the room.

    • getMaximumMessageLength

      @Stability(Stable) @Nullable public 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.

    • setMaximumMessageLength

      @Stability(Stable) public void setMaximumMessageLength(@Nullable Number value)
      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.

    • getMaximumMessageRatePerSecond

      @Stability(Stable) @Nullable public Number getMaximumMessageRatePerSecond()
      Maximum number of messages per second that can be sent to the room (by all clients).

    • setMaximumMessageRatePerSecond

      @Stability(Stable) public void setMaximumMessageRatePerSecond(@Nullable Number value)
      Maximum number of messages per second that can be sent to the room (by all clients).

    • getMessageReviewHandler

      @Stability(Stable) @Nullable public Object getMessageReviewHandler()
      Configuration information for optional review of messages.

    • setMessageReviewHandler

      @Stability(Stable) public void setMessageReviewHandler(@Nullable IResolvable value)
      Configuration information for optional review of messages.

    • setMessageReviewHandler

      @Stability(Stable) public void setMessageReviewHandler(@Nullable CfnRoom.MessageReviewHandlerProperty value)
      Configuration information for optional review of messages.

    • getName

      @Stability(Stable) @Nullable public String getName()
      Room name.

      The value does not need to be unique.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      Room name.

      The value does not need to be unique.