Class: AWSCDK::FSX::CfnVolume::RetentionPeriodProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::FSX::CfnVolume::RetentionPeriodProperty

Defined in:

fsx/cfn_volume.rb

Overview

Specifies the retention period of an FSx for ONTAP SnapLock volume.

After it is set, it can't be changed. Files can't be deleted or modified during the retention period.

For more information, see Working with the retention period in SnapLock .

See Also:

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

Instance Attribute Summary

• #type ⇒ String readonly

  Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.

• #value ⇒ Numeric^? readonly

  Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, value: nil) ⇒ RetentionPeriodProperty constructor

  A new instance of RetentionPeriodProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, value: nil) ⇒ RetentionPeriodProperty

Returns a new instance of RetentionPeriodProperty.

Parameters:

• type (String) —

  Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.

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

  Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

# File 'fsx/cfn_volume.rb', line 1185

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

Instance Attribute Details

#type ⇒ String (readonly)

Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume.

Set it to one of the valid types. If you set it to INFINITE , the files are retained forever. If you set it to UNSPECIFIED , the files are retained until you set an explicit retention period.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-retentionperiod.html#cfn-fsx-volume-retentionperiod-type

# File 'fsx/cfn_volume.rb', line 1198

def type
  @type
end

#value ⇒ Numeric^? (readonly)

Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume.

You can't set a value for INFINITE or UNSPECIFIED . For all other options, the following ranges are valid:

• Seconds : 0 - 65,535
• Minutes : 0 - 65,535
• Hours : 0 - 24
• Days : 0 - 365
• Months : 0 - 12
• Years : 0 - 100

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-retentionperiod.html#cfn-fsx-volume-retentionperiod-value

# File 'fsx/cfn_volume.rb', line 1212

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'fsx/cfn_volume.rb', line 1214

def self.jsii_properties
  {
    :type => "type",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'fsx/cfn_volume.rb', line 1221

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