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();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnRoom
.static interface
The MessageReviewHandler property type specifies configuration information for optional message review.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCreate a newAWS::IVSChat::Room
.CfnRoom
(Construct scope, String id, CfnRoomProps props) Create a newAWS::IVSChat::Room
.protected
CfnRoom
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnRoom
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe room ARN.The room ID.List of logging-configuration identifiers attached to the room.Maximum number of characters in a single message.Maximum number of messages per second that can be sent to the room (by all clients).Configuration information for optional review of messages.getName()
Room name.getTags()
An array of key-value pairs to apply to this resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
List of logging-configuration identifiers attached to the room.void
setMaximumMessageLength
(Number value) Maximum number of characters in a single message.void
Maximum number of messages per second that can be sent to the room (by all clients).void
Configuration information for optional review of messages.void
Configuration information for optional review of messages.void
Room name.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::IVSChat::Room
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnRoom
Create a newAWS::IVSChat::Room
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The room ARN.For example:
arn:aws:ivschat:us-west-2:123456789012:room/abcdABCDefgh
-
getAttrId
The room ID.For example:
abcdABCDefgh
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
An array of key-value pairs to apply to this resource.For more information, see Tag .
-
getLoggingConfigurationIdentifiers
List of logging-configuration identifiers attached to the room. -
setLoggingConfigurationIdentifiers
List of logging-configuration identifiers attached to the room. -
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
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
Maximum number of messages per second that can be sent to the room (by all clients). -
setMaximumMessageRatePerSecond
Maximum number of messages per second that can be sent to the room (by all clients). -
getMessageReviewHandler
Configuration information for optional review of messages. -
setMessageReviewHandler
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
Room name.The value does not need to be unique.
-
setName
Room name.The value does not need to be unique.
-