All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnVolume.OpenZFSConfigurationProperty.Jsii$Proxy

Enclosing class:: CfnVolume

@Stability(Stable) public static interface CfnVolume.OpenZFSConfigurationProperty extends software.amazon.jsii.JsiiSerializable

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.fsx.*;
 OpenZFSConfigurationProperty openZFSConfigurationProperty = OpenZFSConfigurationProperty.builder()
         .parentVolumeId("parentVolumeId")
         // the properties below are optional
         .copyTagsToSnapshots(false)
         .dataCompressionType("dataCompressionType")
         .nfsExports(List.of(NfsExportsProperty.builder()
                 .clientConfigurations(List.of(ClientConfigurationsProperty.builder()
                         .clients("clients")
                         .options(List.of("options"))
                         .build()))
                 .build()))
         .options(List.of("options"))
         .originSnapshot(OriginSnapshotProperty.builder()
                 .copyStrategy("copyStrategy")
                 .snapshotArn("snapshotArn")
                 .build())
         .readOnly(false)
         .recordSizeKiB(123)
         .storageCapacityQuotaGiB(123)
         .storageCapacityReservationGiB(123)
         .userAndGroupQuotas(List.of(UserAndGroupQuotasProperty.builder()
                 .id(123)
                 .storageCapacityQuotaGiB(123)
                 .type("type")
                 .build()))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnVolume.OpenZFSConfigurationProperty.Builder

A builder for CfnVolume.OpenZFSConfigurationProperty

static final class

CfnVolume.OpenZFSConfigurationProperty.Jsii$Proxy

An implementation for CfnVolume.OpenZFSConfigurationProperty
Method Summary

Modifier and Type

Method

Description

static CfnVolume.OpenZFSConfigurationProperty.Builder

builder()

default Object

getCopyTagsToSnapshots()

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

default String

getDataCompressionType()

Specifies the method used to compress the data on the volume.

default Object

getNfsExports()

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

default List<String>

getOptions()

To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .

default Object

getOriginSnapshot()

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

String

getParentVolumeId()

The ID of the volume to use as the parent volume of the volume that you are creating.

default Object

getReadOnly()

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

default Number

getRecordSizeKiB()

Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).

default Number

getStorageCapacityQuotaGiB()

Sets the maximum storage size in gibibytes (GiB) for the volume.

default Number

getStorageCapacityReservationGiB()

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.

default Object

getUserAndGroupQuotas()

Configures how much storage users and groups can use on the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getParentVolumeId
  
  @Stability(Stable) @NotNull String getParentVolumeId()
  
  The ID of the volume to use as the parent volume of the volume that you are creating.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-parentvolumeid
- getCopyTagsToSnapshots
  
  @Stability(Stable) @Nullable default Object getCopyTagsToSnapshots()
  
  A Boolean value indicating whether tags for the volume should be copied to snapshots.
  This value defaults to false . If this value is set to true , and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true , and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-copytagstosnapshots
- getDataCompressionType
  
  @Stability(Stable) @Nullable default String getDataCompressionType()
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-datacompressiontype
- getNfsExports
  
  @Stability(Stable) @Nullable default Object getNfsExports()
  
  The configuration object for mounting a Network File System (NFS) file system.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnVolume.NfsExportsProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-nfsexports
- getOptions
  
  @Stability(Stable) @Nullable default List<String> getOptions()
  
  To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-options
- getOriginSnapshot
  
  @Stability(Stable) @Nullable default Object getOriginSnapshot()
  
  The configuration object that specifies the snapshot to use as the origin of the data for the volume.
  Returns union: either IResolvable or CfnVolume.OriginSnapshotProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-originsnapshot
- getReadOnly
  
  @Stability(Stable) @Nullable default Object getReadOnly()
  
  A Boolean value indicating whether the volume is read-only.
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-readonly
- getRecordSizeKiB
  
  @Stability(Stable) @Nullable default Number getRecordSizeKiB()
  
  Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
  For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-recordsizekib
- getStorageCapacityQuotaGiB
  
  @Stability(Stable) @Nullable default Number getStorageCapacityQuotaGiB()
  
  Sets the maximum storage size in gibibytes (GiB) for the volume.
  You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .
  For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-storagecapacityquotagib
- getStorageCapacityReservationGiB
  
  @Stability(Stable) @Nullable default Number getStorageCapacityReservationGiB()
  
  Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
  Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-storagecapacityreservationgib
- getUserAndGroupQuotas
  
  @Stability(Stable) @Nullable default Object getUserAndGroupQuotas()
  
  Configures how much storage users and groups can use on the volume.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnVolume.UserAndGroupQuotasProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-volume-openzfsconfiguration.html#cfn-fsx-volume-openzfsconfiguration-userandgroupquotas
- builder
  
  @Stability(Stable) static CfnVolume.OpenZFSConfigurationProperty.Builder builder()
  
  Returns:
  
  a CfnVolume.OpenZFSConfigurationProperty.Builder of CfnVolume.OpenZFSConfigurationProperty

Interface CfnVolume.OpenZFSConfigurationProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getParentVolumeId

getCopyTagsToSnapshots

getDataCompressionType

getNfsExports

getOptions

getOriginSnapshot

getReadOnly

getRecordSizeKiB

getStorageCapacityQuotaGiB

getStorageCapacityReservationGiB

getUserAndGroupQuotas

builder