Class: AWSCDK::Rbin::CfnRule::RetentionPeriodProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Rbin::CfnRule::RetentionPeriodProperty

Defined in:

rbin/cfn_rule.rb

Overview

Information about the retention period for which the retention rule is to retain resources.

See Also:

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

Instance Attribute Summary

• #retention_period_unit ⇒ String readonly

  The unit of time in which the retention period is measured.

• #retention_period_value ⇒ Numeric readonly

  The period value for which the retention rule is to retain resources, measured in days.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(retention_period_unit:, retention_period_value:) ⇒ RetentionPeriodProperty constructor

  A new instance of RetentionPeriodProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(retention_period_unit:, retention_period_value:) ⇒ RetentionPeriodProperty

Returns a new instance of RetentionPeriodProperty.

Parameters:

• retention_period_unit (String) —

  The unit of time in which the retention period is measured.

• retention_period_value (Numeric) —

  The period value for which the retention rule is to retain resources, measured in days.

# File 'rbin/cfn_rule.rb', line 680

def initialize(retention_period_unit:, retention_period_value:)
  @retention_period_unit = retention_period_unit
  Jsii::Type.check_type(@retention_period_unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "retentionPeriodUnit")
  @retention_period_value = retention_period_value
  Jsii::Type.check_type(@retention_period_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retentionPeriodValue")
end

Instance Attribute Details

#retention_period_unit ⇒ String (readonly)

The unit of time in which the retention period is measured.

Currently, only DAYS is supported.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodunit

# File 'rbin/cfn_rule.rb', line 693

def retention_period_unit
  @retention_period_unit
end

#retention_period_value ⇒ Numeric (readonly)

The period value for which the retention rule is to retain resources, measured in days.

The supported retention periods are:

• EBS volumes: 1 - 7 days
• EBS snapshots and EBS-backed AMIs: 1 - 365 days

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rbin-rule-retentionperiod.html#cfn-rbin-rule-retentionperiod-retentionperiodvalue

# File 'rbin/cfn_rule.rb', line 703

def retention_period_value
  @retention_period_value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'rbin/cfn_rule.rb', line 705

def self.jsii_properties
  {
    :retention_period_unit => "retentionPeriodUnit",
    :retention_period_value => "retentionPeriodValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'rbin/cfn_rule.rb', line 712

def to_jsii
  result = {}
  result.merge!({
    "retentionPeriodUnit" => @retention_period_unit,
    "retentionPeriodValue" => @retention_period_value,
  })
  result.compact
end