software.amazon.awscdk.services.kinesisvideo

Class CfnSignalingChannel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kinesisvideo.CfnSignalingChannel

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.311Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSignalingChannel(software.constructs.Construct scope, String id) Create a new `AWS::KinesisVideo::SignalingChannel`.
	CfnSignalingChannel(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) of the signaling channel.
protected Map<String,Object>	getCfnProperties()
Number	getMessageTtlSeconds() The period of time a signaling channel retains undelivered messages before they are discarded.
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.
String	getType() A type of the signaling channel that you are creating.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setMessageTtlSeconds(Number value) The period of time a signaling channel retains undelivered messages before they are discarded.
void	setName(String value) A name for the signaling channel that you are creating.
void	setType(String value) A type of the signaling channel that you are creating.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnSignalingChannel(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @Nullable
                                                    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

@Stability(value=Stable)
public CfnSignalingChannel(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getMessageTtlSeconds

@Stability(value=Stable)
 @Nullable
public Number getMessageTtlSeconds()

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

setMessageTtlSeconds

@Stability(value=Stable)
public void setMessageTtlSeconds(@Nullable
                                                          Number value)

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

getName

@Stability(value=Stable)
 @Nullable
public String getName()

A name for the signaling channel that you are creating.

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

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

A name for the signaling channel that you are creating.

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

getType

@Stability(value=Stable)
 @Nullable
public String getType()

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.

setType

@Stability(value=Stable)
public void setType(@Nullable
                                             String value)

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.