Class: AWSCDK::FSX::CfnVolume::TieringPolicyProperty

Inherits:

Jsii::Struct

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

Defined in:

fsx/cfn_volume.rb

Overview

Describes the data tiering policy for an ONTAP volume.

When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.

Valid tiering policies are the following:

• SNAPSHOT_ONLY - (Default value) moves cold snapshots to the capacity pool storage tier.
• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

See Also:

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

Instance Attribute Summary

• #cooling_period ⇒ Numeric^? readonly

  Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.

• #name ⇒ String^? readonly

  Specifies the tiering policy used to transition data.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(cooling_period: nil, name: nil) ⇒ TieringPolicyProperty constructor

  A new instance of TieringPolicyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(cooling_period: nil, name: nil) ⇒ TieringPolicyProperty

Returns a new instance of TieringPolicyProperty.

Parameters:

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

  Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.

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

  Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

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

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

Instance Attribute Details

#cooling_period ⇒ Numeric^? (readonly)

Specifies the number of days that user data in a volume must remain inactive before it is considered "cold" and moved to the capacity pool.

Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY .

Returns:

• (Numeric, nil)

See Also:

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

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

def cooling_period
  @cooling_period
end

#name ⇒ String^? (readonly)

Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY .

• SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
• AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
• ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
• NONE - keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.

Returns:

• (String, nil)

See Also:

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

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

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :cooling_period => "coolingPeriod",
    :name => "name",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "coolingPeriod" => @cooling_period,
    "name" => @name,
  })
  result.compact
end