Class: AWSCDK::KinesisVideo::CfnSignalingChannelProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_video/cfn_signaling_channel_props.rb

Overview

Properties for defining a CfnSignalingChannel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message_ttl_seconds: nil, name: nil, tags: nil, type: nil) ⇒ CfnSignalingChannelProps

Returns a new instance of CfnSignalingChannelProps.

Parameters:

  • message_ttl_seconds (Numeric, nil) (defaults to: nil) —

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

  • name (String, nil) (defaults to: nil) —

    A name for the signaling channel that you are creating.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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

  • type (String, nil) (defaults to: nil) —

    A type of the signaling channel that you are creating.



13
14
15
16
17
18
19
20
21
22
 
# File 'kinesis_video/cfn_signaling_channel_props.rb', line 13

def initialize(message_ttl_seconds: nil, name: nil, tags: nil, type: nil)
  @message_ttl_seconds = message_ttl_seconds
  Jsii::Type.check_type(@message_ttl_seconds, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "messageTtlSeconds") unless @message_ttl_seconds.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#message_ttl_seconds ⇒ Numeric? (readonly)

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

Use API_UpdateSignalingChannel to update this value.

Returns:

  • (Numeric, nil)

See Also:



30
31
32
 
# File 'kinesis_video/cfn_signaling_channel_props.rb', line 30

def message_ttl_seconds
  @message_ttl_seconds
end

#name ⇒ String? (readonly)

A name for the signaling channel that you are creating.

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

Returns:

  • (String, nil)

See Also:



37
38
39
 
# File 'kinesis_video/cfn_signaling_channel_props.rb', line 37

def name
  @name
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

For more information, see Tag .

Returns:

See Also:



44
45
46
 
# File 'kinesis_video/cfn_signaling_channel_props.rb', line 44

def tags
  @tags
end

#type ⇒ String? (readonly)

A type of the signaling channel that you are creating.

Currently, SINGLE_MASTER is the only supported channel type.

Returns:

  • (String, nil)

See Also:



51
52
53
 
# File 'kinesis_video/cfn_signaling_channel_props.rb', line 51

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



53
54
55
56
57
58
59
60
 
# File 'kinesis_video/cfn_signaling_channel_props.rb', line 53

def self.jsii_properties
  {
    :message_ttl_seconds => "messageTtlSeconds",
    :name => "name",
    :tags => "tags",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'kinesis_video/cfn_signaling_channel_props.rb', line 62

def to_jsii
  result = {}
  result.merge!({
    "messageTtlSeconds" => @message_ttl_seconds,
    "name" => @name,
    "tags" => @tags,
    "type" => @type,
  })
  result.compact
end