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

Inherits:

Struct

Object
Struct
Aws::FSx::Types::OpenZFSVolumeConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-fsx/types.rb

Overview

The configuration of an Amazon FSx for OpenZFS volume.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#copy_strategy ⇒ String

Specifies the strategy used when copying data from the snapshot to the new volume.
#copy_tags_to_snapshots ⇒ Boolean

A Boolean value indicating whether tags for the volume should be copied to snapshots.
#data_compression_type ⇒ String

Specifies the method used to compress the data on the volume.
#delete_cloned_volumes ⇒ Boolean

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

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.
#delete_intermediate_snaphots ⇒ Boolean

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

The ID of the snapshot that’s being copied or was most recently copied to the destination volume.
#nfs_exports ⇒ Array<Types::OpenZFSNfsExport>

The configuration object for mounting a Network File System (NFS) file system.
#origin_snapshot ⇒ Types::OpenZFSOriginSnapshotConfiguration

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

The ID of the parent volume.
#read_only ⇒ Boolean

A Boolean value indicating whether the volume is read-only.
#record_size_ki_b ⇒ Integer

The record size of an OpenZFS volume, in kibibytes (KiB).
#restore_to_snapshot ⇒ String

Specifies the ID of the snapshot to which the volume was restored.
#source_snapshot_arn ⇒ String

The Amazon Resource Name (ARN) for a given resource.
#storage_capacity_quota_gi_b ⇒ Integer

The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent.
#storage_capacity_reservation_gi_b ⇒ Integer

The amount of storage in gibibytes (GiB) to reserve from the parent volume.
#user_and_group_quotas ⇒ Array<Types::OpenZFSUserOrGroupQuota>

An object specifying how much storage users or groups can use on the volume.
#volume_path ⇒ String

The path to the volume from the root volume.

Instance Attribute Details

#copy_strategy ⇒ `String`

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.

<note markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_snapshots ⇒ `Boolean`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_type ⇒ `String`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_volumes ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_data ⇒ `Boolean`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_snaphots ⇒ `Boolean`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_snapshot ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_exports ⇒ `Array<Types::OpenZFSNfsExport>`

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

Returns:

(Array<Types::OpenZFSNfsExport>)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_snapshot ⇒ `Types::OpenZFSOriginSnapshotConfiguration`

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

Returns:

(Types::OpenZFSOriginSnapshotConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_id ⇒ `String`

The ID of the parent volume.

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_only ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_b ⇒ `Integer`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_snapshot ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_arn ⇒ `String`

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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_b ⇒ `Integer`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_b ⇒ `Integer`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_quotas ⇒ `Array<Types::OpenZFSUserOrGroupQuota>`

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

Returns:

(Array<Types::OpenZFSUserOrGroupQuota>)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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_path ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 7684

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#copy_strategy ⇒ String

#copy_tags_to_snapshots ⇒ Boolean

#data_compression_type ⇒ String

#delete_cloned_volumes ⇒ Boolean

#delete_intermediate_data ⇒ Boolean

#delete_intermediate_snaphots ⇒ Boolean

#destination_snapshot ⇒ String

#nfs_exports ⇒ Array<Types::OpenZFSNfsExport>

#origin_snapshot ⇒ Types::OpenZFSOriginSnapshotConfiguration

#parent_volume_id ⇒ String

#read_only ⇒ Boolean

#record_size_ki_b ⇒ Integer

#restore_to_snapshot ⇒ String

#source_snapshot_arn ⇒ String

#storage_capacity_quota_gi_b ⇒ Integer

#storage_capacity_reservation_gi_b ⇒ Integer

#user_and_group_quotas ⇒ Array<Types::OpenZFSUserOrGroupQuota>

#volume_path ⇒ String

#copy_strategy ⇒ `String`

#copy_tags_to_snapshots ⇒ `Boolean`

#data_compression_type ⇒ `String`

#delete_cloned_volumes ⇒ `Boolean`

#delete_intermediate_data ⇒ `Boolean`

#delete_intermediate_snaphots ⇒ `Boolean`

#destination_snapshot ⇒ `String`

#nfs_exports ⇒ `Array<Types::OpenZFSNfsExport>`

#origin_snapshot ⇒ `Types::OpenZFSOriginSnapshotConfiguration`

#parent_volume_id ⇒ `String`

#read_only ⇒ `Boolean`

#record_size_ki_b ⇒ `Integer`

#restore_to_snapshot ⇒ `String`

#source_snapshot_arn ⇒ `String`

#storage_capacity_quota_gi_b ⇒ `Integer`

#storage_capacity_reservation_gi_b ⇒ `Integer`

#user_and_group_quotas ⇒ `Array<Types::OpenZFSUserOrGroupQuota>`

#volume_path ⇒ `String`