Class: Aws::FSx::Types::OpenZFSVolumeConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

The configuration of an Amazon FSx for OpenZFS volume.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tags_to_snapshotsBoolean

A Boolean value indicating whether tags for the volume should be copied to snapshots. 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:

  • (Boolean)


6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#data_compression_typeString

The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.

  • NONE - Doesn't compress the data on the volume.

  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.

Returns:

  • (String)


6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#nfs_exportsArray<Types::OpenZFSNfsExport>

The configuration object for mounting a Network File System (NFS) file system.

Returns:



6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#origin_snapshotTypes::OpenZFSOriginSnapshotConfiguration

The configuration object that specifies the snapshot to use as the origin of the data for the volume.



6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#parent_volume_idString

The ID of the parent volume.

Returns:

  • (String)


6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#read_onlyBoolean

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

Returns:

  • (Boolean)


6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity_quota_gi_bInteger

The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

Returns:

  • (Integer)


6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#storage_capacity_reservation_gi_bInteger

The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.

Returns:

  • (Integer)


6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#user_and_group_quotasArray<Types::OpenZFSUserOrGroupQuota>

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

Returns:



6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end

#volume_pathString

The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

Returns:

  • (String)


6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6349

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas)
  SENSITIVE = []
  include Aws::Structure
end