Class: AWSCDK::IoTAnalytics::CfnChannelProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_analytics/cfn_channel_props.rb

Overview

Properties for defining a CfnChannel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(channel_name: nil, channel_storage: nil, retention_period: nil, tags: nil) ⇒ CfnChannelProps

Returns a new instance of CfnChannelProps.

Parameters:



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

def initialize(channel_name: nil, channel_storage: nil, retention_period: nil, tags: nil)
  @channel_name = channel_name
  Jsii::Type.check_type(@channel_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "channelName") unless @channel_name.nil?
  @channel_storage = channel_storage.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnChannel::ChannelStorageProperty.new(**channel_storage.transform_keys(&:to_sym)) : channel_storage
  Jsii::Type.check_type(@channel_storage, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuQ2hhbm5lbC5DaGFubmVsU3RvcmFnZVByb3BlcnR5In1dfX0=")), "channelStorage") unless @channel_storage.nil?
  @retention_period = retention_period.is_a?(Hash) ? ::AWSCDK::IoTAnalytics::CfnChannel::RetentionPeriodProperty.new(**retention_period.transform_keys(&:to_sym)) : retention_period
  Jsii::Type.check_type(@retention_period, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RhbmFseXRpY3MuQ2ZuQ2hhbm5lbC5SZXRlbnRpb25QZXJpb2RQcm9wZXJ0eSJ9XX19")), "retentionPeriod") unless @retention_period.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?
end

Instance Attribute Details

#channel_name ⇒ String? (readonly)

The name of the channel.

Returns:

  • (String, nil)

See Also:



28
29
30
 
# File 'io_t_analytics/cfn_channel_props.rb', line 28

def channel_name
  @channel_name
end

#channel_storage ⇒ AWSCDK::IResolvable, ... (readonly)

Where channel data is stored.

Returns:

See Also:



33
34
35
 
# File 'io_t_analytics/cfn_channel_props.rb', line 33

def channel_storage
  @channel_storage
end

#retention_period ⇒ AWSCDK::IResolvable, ... (readonly)

How long, in days, message data is kept for the channel.

Returns:

See Also:



38
39
40
 
# File 'io_t_analytics/cfn_channel_props.rb', line 38

def retention_period
  @retention_period
end

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

Metadata which can be used to manage the channel.

For more information, see Tag .

Returns:

See Also:



45
46
47
 
# File 'io_t_analytics/cfn_channel_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'io_t_analytics/cfn_channel_props.rb', line 47

def self.jsii_properties
  {
    :channel_name => "channelName",
    :channel_storage => "channelStorage",
    :retention_period => "retentionPeriod",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'io_t_analytics/cfn_channel_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "channelName" => @channel_name,
    "channelStorage" => @channel_storage,
    "retentionPeriod" => @retention_period,
    "tags" => @tags,
  })
  result.compact
end