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_strategyString

Specifies the strategy used when copying data from the snapshot to the new volume.

  • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

  • FULL_COPY - Copies all data from the snapshot to the new volume.

    Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

Returns:

  • (String)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#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)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#data_compression_typeString

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)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#delete_cloned_volumesBoolean

A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

Returns:

  • (Boolean)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#delete_intermediate_dataBoolean

A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

Returns:

  • (Boolean)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#delete_intermediate_snaphotsBoolean

A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

Returns:

  • (Boolean)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#destination_snapshotString

The ID of the snapshot that's being copied or was most recently copied to the destination volume.

Returns:

  • (String)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#nfs_exportsArray<Types::OpenZFSNfsExport>

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

Returns:



7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  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.



7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#parent_volume_idString

The ID of the parent volume.

Returns:

  • (String)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#read_onlyBoolean

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

Returns:

  • (Boolean)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#record_size_ki_bInteger

The record size of an OpenZFS 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. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.

Returns:

  • (Integer)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#restore_to_snapshotString

Specifies the ID of the snapshot to which the volume was restored.

Returns:

  • (String)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#source_snapshot_arnString

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Returns:

  • (String)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  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)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  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)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  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:



7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#volume_pathString

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

Returns:

  • (String)


7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7514

class OpenZFSVolumeConfiguration < Struct.new(
  :parent_volume_id,
  :volume_path,
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :copy_tags_to_snapshots,
  :origin_snapshot,
  :read_only,
  :nfs_exports,
  :user_and_group_quotas,
  :restore_to_snapshot,
  :delete_intermediate_snaphots,
  :delete_cloned_volumes,
  :delete_intermediate_data,
  :source_snapshot_arn,
  :destination_snapshot,
  :copy_strategy)
  SENSITIVE = []
  include Aws::Structure
end