software.amazon.awscdk.services.kinesisvideo

Class CfnSignalingChannel

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.kinesisvideo.CfnSignalingChannel

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.647Z")
public class CfnSignalingChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::KinesisVideo::SignalingChannel`.

Specifies a signaling channel.

CreateSignalingChannel is an asynchronous operation.

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.*;
 CfnSignalingChannel cfnSignalingChannel = CfnSignalingChannel.Builder.create(this, "MyCfnSignalingChannel")
         .messageTtlSeconds(123)
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSignalingChannel.Builder A fluent builder for CfnSignalingChannel.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSignalingChannel(Construct scope, java.lang.String id) Create a new `AWS::KinesisVideo::SignalingChannel`.
	CfnSignalingChannel(Construct scope, java.lang.String id, CfnSignalingChannelProps props) Create a new `AWS::KinesisVideo::SignalingChannel`.
protected	CfnSignalingChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSignalingChannel(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the signaling channel.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Number	getMessageTtlSeconds() The period of time a signaling channel retains undelivered messages before they are discarded.
java.lang.String	getName() A name for the signaling channel that you are creating.
TagManager	getTags() An array of key-value pairs to apply to this resource.
java.lang.String	getType() A type of the signaling channel that you are creating.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setMessageTtlSeconds(java.lang.Number value) The period of time a signaling channel retains undelivered messages before they are discarded.
void	setName(java.lang.String value) A name for the signaling channel that you are creating.
void	setType(java.lang.String value) A type of the signaling channel that you are creating.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSignalingChannel

protected CfnSignalingChannel(software.amazon.jsii.JsiiObjectRef objRef)

CfnSignalingChannel

protected CfnSignalingChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSignalingChannel

public CfnSignalingChannel(Construct scope,
                           java.lang.String id,
                           CfnSignalingChannelProps props)

Create a new `AWS::KinesisVideo::SignalingChannel`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnSignalingChannel

public CfnSignalingChannel(Construct scope,
                           java.lang.String id)

Create a new `AWS::KinesisVideo::SignalingChannel`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the signaling channel.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

For more information, see Tag .

getMessageTtlSeconds

public java.lang.Number getMessageTtlSeconds()

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

setMessageTtlSeconds

public void setMessageTtlSeconds(java.lang.Number value)

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

getName

public java.lang.String getName()

A name for the signaling channel that you are creating.

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

setName

public void setName(java.lang.String value)

A name for the signaling channel that you are creating.

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

getType

public java.lang.String getType()

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.

setType

public void setType(java.lang.String value)

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.