Class CfnSignalingChannel
A CloudFormation AWS::KinesisVideo::SignalingChannel
.
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisVideo
Assembly: Amazon.CDK.AWS.KinesisVideo.dll
Syntax (csharp)
public class CfnSignalingChannel : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSignalingChannel
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a signaling channel.
CreateSignalingChannel
is an asynchronous operation.
CloudformationResource: AWS::KinesisVideo::SignalingChannel
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.KinesisVideo;
var cfnSignalingChannel = new CfnSignalingChannel(this, "MyCfnSignalingChannel", new CfnSignalingChannelProps {
MessageTtlSeconds = 123,
Name = "name",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type"
});
Synopsis
Constructors
CfnSignalingChannel(Construct, String, ICfnSignalingChannelProps) | Create a new |
CfnSignalingChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSignalingChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the signaling channel. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
MessageTtlSeconds | The period of time a signaling channel retains undelivered messages before they are discarded. |
Name | A name for the signaling channel that you are creating. |
Tags | An array of key-value pairs to apply to this resource. |
Type | A type of the signaling channel that you are creating. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSignalingChannel(Construct, String, ICfnSignalingChannelProps)
Create a new AWS::KinesisVideo::SignalingChannel
.
public CfnSignalingChannel(Construct scope, string id, ICfnSignalingChannelProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSignalingChannelProps
- resource properties.
CfnSignalingChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSignalingChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSignalingChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSignalingChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the signaling channel.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
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
MessageTtlSeconds
The period of time a signaling channel retains undelivered messages before they are discarded.
public virtual Nullable<double> MessageTtlSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Name
A name for the signaling channel that you are creating.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
It must be unique for each AWS account and AWS Region .
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Type
A type of the signaling channel that you are creating.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Currently, SINGLE_MASTER
is the only supported channel type.
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>