software.amazon.awscdk.services.fsx

Interface CfnFileSystem.RootVolumeConfigurationProperty

All Known Implementing Classes:

CfnFileSystem.RootVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

public static interface CfnFileSystem.RootVolumeConfigurationProperty

The configuration of an Amazon FSx for OpenZFS root volume.

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.*;
 RootVolumeConfigurationProperty rootVolumeConfigurationProperty = RootVolumeConfigurationProperty.builder()
         .copyTagsToSnapshots(false)
         .dataCompressionType("dataCompressionType")
         .nfsExports(List.of(NfsExportsProperty.builder()
                 .clientConfigurations(List.of(ClientConfigurationsProperty.builder()
                         .clients("clients")
                         .options(List.of("options"))
                         .build()))
                 .build()))
         .readOnly(false)
         .recordSizeKiB(123)
         .userAndGroupQuotas(List.of(UserAndGroupQuotasProperty.builder()
                 .id(123)
                 .storageCapacityQuotaGiB(123)
                 .type("type")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFileSystem.RootVolumeConfigurationProperty.Builder A builder for CfnFileSystem.RootVolumeConfigurationProperty
static class	CfnFileSystem.RootVolumeConfigurationProperty.Jsii$Proxy An implementation for CfnFileSystem.RootVolumeConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnFileSystem.RootVolumeConfigurationProperty.Builder	builder()
default java.lang.Object	getCopyTagsToSnapshots() A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume.
default java.lang.String	getDataCompressionType() Specifies the method used to compress the data on the volume.
default java.lang.Object	getNfsExports() The configuration object for mounting a file system.
default java.lang.Object	getReadOnly() A Boolean value indicating whether the volume is read-only.
default java.lang.Number	getRecordSizeKiB() Specifies the record size of an OpenZFS root volume, in kibibytes (KiB).
default java.lang.Object	getUserAndGroupQuotas() An object specifying how much storage users or groups can use on the volume.

Method Detail

getCopyTagsToSnapshots

default java.lang.Object getCopyTagsToSnapshots()

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.

getDataCompressionType

default java.lang.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.

getNfsExports

default java.lang.Object getNfsExports()

The configuration object for mounting a file system.

getReadOnly

default java.lang.Object getReadOnly()

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.

getRecordSizeKiB

default java.lang.Number getRecordSizeKiB()

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 .

getUserAndGroupQuotas

default java.lang.Object getUserAndGroupQuotas()

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

builder

static CfnFileSystem.RootVolumeConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.RootVolumeConfigurationProperty.Builder of CfnFileSystem.RootVolumeConfigurationProperty