Package software.amazon.awscdk.services.kinesisvideo

Interface CfnSignalingChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSignalingChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:08.283Z")
@Stability(Stable)
public interface CfnSignalingChannelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSignalingChannel.

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.kinesisvideo.*;
 CfnSignalingChannelProps cfnSignalingChannelProps = CfnSignalingChannelProps.builder()
         .messageTtlSeconds(123)
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSignalingChannelProps.Builder	A builder for CfnSignalingChannelProps
static final class	CfnSignalingChannelProps.Jsii$Proxy	An implementation for CfnSignalingChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnSignalingChannelProps.Builder	builder()
default Number	getMessageTtlSeconds()	The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded.
default String	getName()	A name for the signaling channel that you are creating.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getType()	A type of the signaling channel that you are creating.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMessageTtlSeconds

@Stability(Stable)
@Nullable
default Number getMessageTtlSeconds()

The period of time (in seconds) a signaling channel retains undelivered messages before they are discarded.

Use API_UpdateSignalingChannel to update this value.

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

A name for the signaling channel that you are creating.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.

See Also:

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

builder

@Stability(Stable)
static CfnSignalingChannelProps.Builder builder()

Returns:

a CfnSignalingChannelProps.Builder of CfnSignalingChannelProps