CfnSignalingChannelProps

class aws_cdk.aws_kinesisvideo.CfnSignalingChannelProps(*, message_ttl_seconds=None, name=None, tags=None, type=None)

Bases: object

Properties for defining a CfnSignalingChannel.

Parameters:
  • message_ttl_seconds (Union[int, float, None]) – The period of time a signaling channel retains undelivered messages before they are discarded.

  • name (Optional[str]) – A name for the signaling channel that you are creating. It must be unique for each AWS account and AWS Region .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • type (Optional[str]) – A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only supported channel type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_kinesisvideo as kinesisvideo

cfn_signaling_channel_props = kinesisvideo.CfnSignalingChannelProps(
    message_ttl_seconds=123,
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
)

Attributes

message_ttl_seconds

The period of time a signaling channel retains undelivered messages before they are discarded.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-messagettlseconds

name

A name for the signaling channel that you are creating.

It must be unique for each AWS account and AWS Region .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-name

tags

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

For more information, see Tag .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-tags

type

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-signalingchannel.html#cfn-kinesisvideo-signalingchannel-type