Class: AWSCDK::IoTAnalytics::CfnChannel::RetentionPeriodProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::IoTAnalytics::CfnChannel::RetentionPeriodProperty

Defined in:

io_t_analytics/cfn_channel.rb

Overview

How long, in days, message data is kept.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html

Instance Attribute Summary

• #number_of_days ⇒ Numeric^? readonly

  The number of days that message data is kept.

• #unlimited ⇒ Boolean, ... readonly

  If true, message data is kept indefinitely.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(number_of_days: nil, unlimited: nil) ⇒ RetentionPeriodProperty constructor

  A new instance of RetentionPeriodProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(number_of_days: nil, unlimited: nil) ⇒ RetentionPeriodProperty

Returns a new instance of RetentionPeriodProperty.

Parameters:

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

  The number of days that message data is kept.

• unlimited (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  If true, message data is kept indefinitely.

# File 'io_t_analytics/cfn_channel.rb', line 676

def initialize(number_of_days: nil, unlimited: nil)
  @number_of_days = number_of_days
  Jsii::Type.check_type(@number_of_days, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numberOfDays") unless @number_of_days.nil?
  @unlimited = unlimited
  Jsii::Type.check_type(@unlimited, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "unlimited") unless @unlimited.nil?
end

Instance Attribute Details

#number_of_days ⇒ Numeric^? (readonly)

The number of days that message data is kept.

The unlimited parameter must be false.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-numberofdays

# File 'io_t_analytics/cfn_channel.rb', line 689

def number_of_days
  @number_of_days
end

#unlimited ⇒ Boolean, ... (readonly)

If true, message data is kept indefinitely.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotanalytics-channel-retentionperiod.html#cfn-iotanalytics-channel-retentionperiod-unlimited

# File 'io_t_analytics/cfn_channel.rb', line 694

def unlimited
  @unlimited
end

Class Method Details

.jsii_properties ⇒ Object

# File 'io_t_analytics/cfn_channel.rb', line 696

def self.jsii_properties
  {
    :number_of_days => "numberOfDays",
    :unlimited => "unlimited",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'io_t_analytics/cfn_channel.rb', line 703

def to_jsii
  result = {}
  result.merge!({
    "numberOfDays" => @number_of_days,
    "unlimited" => @unlimited,
  })
  result.compact
end