Class CfnRoom
A CloudFormation AWS::IVSChat::Room
.
Inherited Members
Namespace: Amazon.CDK.AWS.IVSChat
Assembly: Amazon.CDK.AWS.IVSChat.dll
Syntax (csharp)
public class CfnRoom : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnRoom
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::IVSChat::Room
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IVSChat;
var cfnRoom = new CfnRoom(this, "MyCfnRoom", new CfnRoomProps {
LoggingConfigurationIdentifiers = new [] { "loggingConfigurationIdentifiers" },
MaximumMessageLength = 123,
MaximumMessageRatePerSecond = 123,
MessageReviewHandler = new MessageReviewHandlerProperty {
FallbackResult = "fallbackResult",
Uri = "uri"
},
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnRoom(Construct, String, ICfnRoomProps) | Create a new |
CfnRoom(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnRoom(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The room ARN. |
AttrId | The room ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
LoggingConfigurationIdentifiers | List of logging-configuration identifiers attached to the room. |
MaximumMessageLength | Maximum number of characters in a single message. |
MaximumMessageRatePerSecond | Maximum number of messages per second that can be sent to the room (by all clients). |
MessageReviewHandler | Configuration information for optional review of messages. |
Name | Room name. |
Tags | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnRoom(Construct, String, ICfnRoomProps)
Create a new AWS::IVSChat::Room
.
public CfnRoom(Construct scope, string id, ICfnRoomProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnRoomProps
- resource properties.
CfnRoom(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnRoom(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnRoom(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnRoom(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The room ARN.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example: arn:aws:ivschat:us-west-2:123456789012:room/abcdABCDefgh
CloudformationAttribute: Arn
AttrId
The room ID.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
For example: abcdABCDefgh
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
LoggingConfigurationIdentifiers
List of logging-configuration identifiers attached to the room.
public virtual string[] LoggingConfigurationIdentifiers { get; set; }
Property Value
System.String[]
Remarks
MaximumMessageLength
Maximum number of characters in a single message.
public virtual Nullable<double> MaximumMessageLength { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes.
MaximumMessageRatePerSecond
Maximum number of messages per second that can be sent to the room (by all clients).
public virtual Nullable<double> MaximumMessageRatePerSecond { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
MessageReviewHandler
Configuration information for optional review of messages.
public virtual object MessageReviewHandler { get; set; }
Property Value
System.Object
Remarks
Name
Room name.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The value does not need to be unique.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>