Package software.amazon.awscdk.services.kinesisvideo

Class CfnSignalingChannel

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.378Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSignalingChannel

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

    • CfnSignalingChannel

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

    • CfnSignalingChannel

      @Stability(Stable) public CfnSignalingChannel(@NotNull 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(Stable) public CfnSignalingChannel(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the signaling channel.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • getMessageTtlSeconds

      @Stability(Stable) @Nullable public Number getMessageTtlSeconds()
      The period of time a signaling channel retains undelivered messages before they are discarded.

    • setMessageTtlSeconds

      @Stability(Stable) public void setMessageTtlSeconds(@Nullable Number value)
      The period of time a signaling channel retains undelivered messages before they are discarded.

    • getName

      @Stability(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(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(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(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.