Class: AWSCDK::FSX::CfnFileSystem::RootVolumeConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
fsx/cfn_file_system.rb

Overview

The configuration of an Amazon FSx for OpenZFS root volume.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(copy_tags_to_snapshots: nil, data_compression_type: nil, nfs_exports: nil, read_only: nil, record_size_kib: nil, user_and_group_quotas: nil) ⇒ RootVolumeConfigurationProperty

Returns a new instance of RootVolumeConfigurationProperty.

Parameters:



1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
 
# File 'fsx/cfn_file_system.rb', line 1785

def initialize(copy_tags_to_snapshots: nil, data_compression_type: nil, nfs_exports: nil, read_only: nil, record_size_kib: nil, user_and_group_quotas: nil)
  @copy_tags_to_snapshots = copy_tags_to_snapshots
  Jsii::Type.check_type(@copy_tags_to_snapshots, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "copyTagsToSnapshots") unless @copy_tags_to_snapshots.nil?
  @data_compression_type = data_compression_type
  Jsii::Type.check_type(@data_compression_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataCompressionType") unless @data_compression_type.nil?
  @nfs_exports = nfs_exports
  Jsii::Type.check_type(@nfs_exports, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZnN4LkNmbkZpbGVTeXN0ZW0uTmZzRXhwb3J0c1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "nfsExports") unless @nfs_exports.nil?
  @read_only = read_only
  Jsii::Type.check_type(@read_only, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "readOnly") unless @read_only.nil?
  @record_size_kib = record_size_kib
  Jsii::Type.check_type(@record_size_kib, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "recordSizeKiB") unless @record_size_kib.nil?
  @user_and_group_quotas = user_and_group_quotas
  Jsii::Type.check_type(@user_and_group_quotas, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZnN4LkNmbkZpbGVTeXN0ZW0uVXNlckFuZEdyb3VwUXVvdGFzUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "userAndGroupQuotas") unless @user_and_group_quotas.nil?
end

Instance Attribute Details

#copy_tags_to_snapshots ⇒ Boolean, ... (readonly)

A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume.

This value defaults to false . If it's set to true , all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

Returns:

See Also:



1806
1807
1808
 
# File 'fsx/cfn_file_system.rb', line 1806

def copy_tags_to_snapshots
  @copy_tags_to_snapshots
end

#data_compression_type ⇒ String? (readonly)

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.
  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

Returns:

  • (String, nil)

See Also:



1815
1816
1817
 
# File 'fsx/cfn_file_system.rb', line 1815

def data_compression_type
  @data_compression_type
end

#nfs_exports ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration object for mounting a file system.

Returns:

See Also:



1820
1821
1822
 
# File 'fsx/cfn_file_system.rb', line 1820

def nfs_exports
  @nfs_exports
end

#read_only ⇒ Boolean, ... (readonly)

A Boolean value indicating whether the volume is read-only.

Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

Returns:

See Also:



1827
1828
1829
 
# File 'fsx/cfn_file_system.rb', line 1827

def read_only
  @read_only
end

#record_size_kib ⇒ Numeric? (readonly)

Specifies the record size of an OpenZFS root volume, in kibibytes (KiB).

Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide .

Returns:

  • (Numeric, nil)

See Also:



1834
1835
1836
 
# File 'fsx/cfn_file_system.rb', line 1834

def record_size_kib
  @record_size_kib
end

#user_and_group_quotas ⇒ AWSCDK::IResolvable, ... (readonly)

An object specifying how much storage users or groups can use on the volume.

Returns:

See Also:



1839
1840
1841
 
# File 'fsx/cfn_file_system.rb', line 1839

def user_and_group_quotas
  @user_and_group_quotas
end

Class Method Details

.jsii_properties ⇒ Object 



1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
 
# File 'fsx/cfn_file_system.rb', line 1841

def self.jsii_properties
  {
    :copy_tags_to_snapshots => "copyTagsToSnapshots",
    :data_compression_type => "dataCompressionType",
    :nfs_exports => "nfsExports",
    :read_only => "readOnly",
    :record_size_kib => "recordSizeKiB",
    :user_and_group_quotas => "userAndGroupQuotas",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
 
# File 'fsx/cfn_file_system.rb', line 1852

def to_jsii
  result = {}
  result.merge!({
    "copyTagsToSnapshots" => @copy_tags_to_snapshots,
    "dataCompressionType" => @data_compression_type,
    "nfsExports" => @nfs_exports,
    "readOnly" => @read_only,
    "recordSizeKiB" => @record_size_kib,
    "userAndGroupQuotas" => @user_and_group_quotas,
  })
  result.compact
end