Class: AWSCDK::Logs::StreamOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
logs/stream_options.rb

Overview

Properties for a new LogStream created from a LogGroup.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(log_stream_name: nil) ⇒ StreamOptions

Returns a new instance of StreamOptions.

Parameters:

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

    The name of the log stream to create.



8
9
10
11
 
# File 'logs/stream_options.rb', line 8

def initialize(log_stream_name: nil)
  @log_stream_name = log_stream_name
  Jsii::Type.check_type(@log_stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logStreamName") unless @log_stream_name.nil?
end

Instance Attribute Details

#log_stream_name ⇒ String? (readonly)

Note:

Default: Automatically generated

The name of the log stream to create.

The name must be unique within the log group.

Returns:

  • (String, nil) 


19
20
21
 
# File 'logs/stream_options.rb', line 19

def log_stream_name
  @log_stream_name
end

Class Method Details

.jsii_properties ⇒ Object 



21
22
23
24
25
 
# File 'logs/stream_options.rb', line 21

def self.jsii_properties
  {
    :log_stream_name => "logStreamName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



27
28
29
30
31
32
33
 
# File 'logs/stream_options.rb', line 27

def to_jsii
  result = {}
  result.merge!({
    "logStreamName" => @log_stream_name,
  })
  result.compact
end