Class: AWSCDK::FSX::CfnFileSystem::ReadCacheConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::FSX::CfnFileSystem::ReadCacheConfigurationProperty

Defined in:

fsx/cfn_file_system.rb

Overview

The configuration for the optional provisioned SSD read cache on Amazon FSx for OpenZFS file systems that use the Intelligent-Tiering storage class.

See Also:

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

Instance Attribute Summary

• #size_gib ⇒ Numeric^? readonly

  Required if SizingMode is set to USER_PROVISIONED .

• #sizing_mode ⇒ String^? readonly

  Specifies how the provisioned SSD read cache is sized, as follows:.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(size_gib: nil, sizing_mode: nil) ⇒ ReadCacheConfigurationProperty constructor

  A new instance of ReadCacheConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(size_gib: nil, sizing_mode: nil) ⇒ ReadCacheConfigurationProperty

Returns a new instance of ReadCacheConfigurationProperty.

Parameters:

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

  Required if SizingMode is set to USER_PROVISIONED .

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

  Specifies how the provisioned SSD read cache is sized, as follows:.

# File 'fsx/cfn_file_system.rb', line 1732

def initialize(size_gib: nil, sizing_mode: nil)
  @size_gib = size_gib
  Jsii::Type.check_type(@size_gib, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sizeGiB") unless @size_gib.nil?
  @sizing_mode = sizing_mode
  Jsii::Type.check_type(@sizing_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sizingMode") unless @sizing_mode.nil?
end

Instance Attribute Details

#size_gib ⇒ Numeric^? (readonly)

Required if SizingMode is set to USER_PROVISIONED .

Specifies the size of the file system's SSD read cache, in gibibytes (GiB).

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.html#cfn-fsx-filesystem-readcacheconfiguration-sizegib

# File 'fsx/cfn_file_system.rb', line 1745

def size_gib
  @size_gib
end

#sizing_mode ⇒ String^? (readonly)

Specifies how the provisioned SSD read cache is sized, as follows:.

• Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.
• Set to USER_PROVISIONED to specify the exact size of your SSD read cache.
• Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.html#cfn-fsx-filesystem-readcacheconfiguration-sizingmode

# File 'fsx/cfn_file_system.rb', line 1754

def sizing_mode
  @sizing_mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'fsx/cfn_file_system.rb', line 1756

def self.jsii_properties
  {
    :size_gib => "sizeGiB",
    :sizing_mode => "sizingMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'fsx/cfn_file_system.rb', line 1763

def to_jsii
  result = {}
  result.merge!({
    "sizeGiB" => @size_gib,
    "sizingMode" => @sizing_mode,
  })
  result.compact
end