Class: AWSCDK::Kinesis::StreamConsumerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis/stream_consumer_props.rb

Overview

Properties for a Kinesis Stream Consumer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stream:, stream_consumer_name:) ⇒ StreamConsumerProps

Returns a new instance of StreamConsumerProps.

Parameters:

  • stream (AWSCDK::Kinesis::IStream) —

    The Kinesis data stream to associate this consumer with.

  • stream_consumer_name (String) —

    The name of the stream consumer.



9
10
11
12
13
14
 
# File 'kinesis/stream_consumer_props.rb', line 9

def initialize(stream:, stream_consumer_name:)
  @stream = stream
  Jsii::Type.check_type(@stream, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2luZXNpcy5JU3RyZWFtIn0=")), "stream")
  @stream_consumer_name = stream_consumer_name
  Jsii::Type.check_type(@stream_consumer_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamConsumerName")
end

Instance Attribute Details

#stream ⇒ AWSCDK::Kinesis::IStream (readonly)

The Kinesis data stream to associate this consumer with.

Returns:



19
20
21
 
# File 'kinesis/stream_consumer_props.rb', line 19

def stream
  @stream
end

#stream_consumer_name ⇒ String (readonly)

The name of the stream consumer.

Returns:

  • (String) 


23
24
25
 
# File 'kinesis/stream_consumer_props.rb', line 23

def stream_consumer_name
  @stream_consumer_name
end

Class Method Details

.jsii_properties ⇒ Object 



25
26
27
28
29
30
 
# File 'kinesis/stream_consumer_props.rb', line 25

def self.jsii_properties
  {
    :stream => "stream",
    :stream_consumer_name => "streamConsumerName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



32
33
34
35
36
37
38
39
 
# File 'kinesis/stream_consumer_props.rb', line 32

def to_jsii
  result = {}
  result.merge!({
    "stream" => @stream,
    "streamConsumerName" => @stream_consumer_name,
  })
  result.compact
end