CfnRoomPropsMixin

class aws_cdk.mixins_preview.aws_ivschat.mixins.CfnRoomPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivschat-room.html
CloudformationResource:: AWS::IVSChat::Room
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ivschat import mixins as ivschat_mixins

cfn_room_props_mixin = ivschat_mixins.CfnRoomPropsMixin(ivschat_mixins.CfnRoomMixinProps(
    logging_configuration_identifiers=["loggingConfigurationIdentifiers"],
    maximum_message_length=123,
    maximum_message_rate_per_second=123,
    message_review_handler=ivschat_mixins.CfnRoomPropsMixin.MessageReviewHandlerProperty(
        fallback_result="fallbackResult",
        uri="uri"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IVSChat::Room.

Parameters:

props (Union[CfnRoomMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['loggingConfigurationIdentifiers', 'maximumMessageLength', 'maximumMessageRatePerSecond', 'messageReviewHandler', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

MessageReviewHandlerProperty

class CfnRoomPropsMixin.MessageReviewHandlerProperty(*, fallback_result=None, uri=None)

Bases: object

The MessageReviewHandler property type specifies configuration information for optional message review.

Parameters:

fallback_result (Optional[str]) – Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out. (For the timeout period, see Service Quotas .) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user. Default : ALLOW Default: - “ALLOW”
uri (Optional[str]) – Identifier of the message review handler. Currently this must be an ARN of a lambda function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-room-messagereviewhandler.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ivschat import mixins as ivschat_mixins

message_review_handler_property = ivschat_mixins.CfnRoomPropsMixin.MessageReviewHandlerProperty(
    fallback_result="fallbackResult",
    uri="uri"
)

Attributes

fallback_result

Specifies the fallback behavior (whether the message is allowed or denied) if the handler does not return a valid response, encounters an error, or times out.

(For the timeout period, see Service Quotas .) If allowed, the message is delivered with returned content to all users connected to the room. If denied, the message is not delivered to any user.

Default : ALLOW

Default:

“ALLOW”

See:

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

uri

Identifier of the message review handler.

Currently this must be an ARN of a lambda function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivschat-room-messagereviewhandler.html#cfn-ivschat-room-messagereviewhandler-uri