software.amazon.awscdk.services.fsx

Interface CfnFileSystem.OpenZFSConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFileSystem.OpenZFSConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFileSystem

@Stability(value=Stable)
public static interface CfnFileSystem.OpenZFSConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The OpenZFS configuration for the file system that's being created.

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()
         .deploymentType("deploymentType")
         // the properties below are optional
         .automaticBackupRetentionDays(123)
         .copyTagsToBackups(false)
         .copyTagsToVolumes(false)
         .dailyAutomaticBackupStartTime("dailyAutomaticBackupStartTime")
         .diskIopsConfiguration(DiskIopsConfigurationProperty.builder()
                 .iops(123)
                 .mode("mode")
                 .build())
         .options(List.of("options"))
         .rootVolumeConfiguration(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())
         .throughputCapacity(123)
         .weeklyMaintenanceStartTime("weeklyMaintenanceStartTime")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFileSystem.OpenZFSConfigurationProperty.Builder	builder()
default Number	getAutomaticBackupRetentionDays() The number of days to retain automatic backups.
default Object	getCopyTagsToBackups() A Boolean value indicating whether tags for the file system should be copied to backups.
default Object	getCopyTagsToVolumes() A Boolean value indicating whether tags for the volume should be copied to snapshots.
default String	getDailyAutomaticBackupStartTime() A recurring daily time, in the format `HH:MM` .
String	getDeploymentType() Specifies the file system deployment type.
default Object	getDiskIopsConfiguration() The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system.
default List<String>	getOptions() To delete a file system if there are child volumes present below the root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS` .
default Object	getRootVolumeConfiguration() The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.
default Number	getThroughputCapacity() Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s).
default String	getWeeklyMaintenanceStartTime() A recurring weekly time, in the format `D:HH:MM` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeploymentType

@Stability(value=Stable)
 @NotNull
String getDeploymentType()

Specifies the file system deployment type.

Amazon FSx for OpenZFS supports SINGLE_AZ_1 . SINGLE_AZ_1 deployment type is configured for redundancy within a single Availability Zone.

getAutomaticBackupRetentionDays

@Stability(value=Stable)
 @Nullable
default Number getAutomaticBackupRetentionDays()

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0 .

getCopyTagsToBackups

@Stability(value=Stable)
 @Nullable
default Object getCopyTagsToBackups()

A Boolean value indicating whether tags for the file system should be copied to backups.

This value defaults to false . If it's set to true , all tags for the file system are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

getCopyTagsToVolumes

@Stability(value=Stable)
 @Nullable
default Object getCopyTagsToVolumes()

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.

getDailyAutomaticBackupStartTime

@Stability(value=Stable)
 @Nullable
default String getDailyAutomaticBackupStartTime()

A recurring daily time, in the format `HH:MM` .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

getDiskIopsConfiguration

@Stability(value=Stable)
 @Nullable
default Object getDiskIopsConfiguration()

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system.

The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).

getOptions

@Stability(value=Stable)
 @Nullable
default List<String> getOptions()

To delete a file system if there are child volumes present below the root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS` .

If your file system has child volumes and you don't use this option, the delete request will fail.

getRootVolumeConfiguration

@Stability(value=Stable)
 @Nullable
default Object getRootVolumeConfiguration()

The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.

All volumes are children of the root volume.

getThroughputCapacity

@Stability(value=Stable)
 @Nullable
default Number getThroughputCapacity()

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s).

Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. You pay for additional throughput capacity that you provision.

getWeeklyMaintenanceStartTime

@Stability(value=Stable)
 @Nullable
default String getWeeklyMaintenanceStartTime()

A recurring weekly time, in the format `D:HH:MM` .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

builder

@Stability(value=Stable)
static CfnFileSystem.OpenZFSConfigurationProperty.Builder builder()

Returns:

a CfnFileSystem.OpenZFSConfigurationProperty.Builder of CfnFileSystem.OpenZFSConfigurationProperty