Package software.amazon.awscdk.services.fsx

Interface CfnFileSystem.RootVolumeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.RootVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

@Stability(Stable)
public static interface CfnFileSystem.RootVolumeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCopyTagsToSnapshots

@Stability(Stable)
@Nullable
default 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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-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-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-datacompressiontype

getNfsExports

@Stability(Stable)
@Nullable
default Object getNfsExports()

The configuration object for mounting a file system.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFileSystem.NfsExportsProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-nfsexports

getReadOnly

@Stability(Stable)
@Nullable
default 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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-readonly

getRecordSizeKiB

@Stability(Stable)
@Nullable
default 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-recordsizekib

getUserAndGroupQuotas

@Stability(Stable)
@Nullable
default Object getUserAndGroupQuotas()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFileSystem.UserAndGroupQuotasProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-userandgroupquotas

builder

@Stability(Stable)
static CfnFileSystem.RootVolumeConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.RootVolumeConfigurationProperty.Builder of CfnFileSystem.RootVolumeConfigurationProperty