Class CfnFileSystem.OpenZFSConfigurationProperty
The OpenZFS configuration for the file system that's being created.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class OpenZFSConfigurationProperty : Object, CfnFileSystem.IOpenZFSConfigurationProperty
Syntax (vb)
Public Class OpenZFSConfigurationProperty
Inherits Object
Implements CfnFileSystem.IOpenZFSConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FSx;
var openZFSConfigurationProperty = new OpenZFSConfigurationProperty {
DeploymentType = "deploymentType",
// the properties below are optional
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = false,
CopyTagsToVolumes = false,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DiskIopsConfiguration = new DiskIopsConfigurationProperty {
Iops = 123,
Mode = "mode"
},
EndpointIpAddressRange = "endpointIpAddressRange",
Options = new [] { "options" },
PreferredSubnetId = "preferredSubnetId",
RootVolumeConfiguration = new RootVolumeConfigurationProperty {
CopyTagsToSnapshots = false,
DataCompressionType = "dataCompressionType",
NfsExports = new [] { new NfsExportsProperty {
ClientConfigurations = new [] { new ClientConfigurationsProperty {
Clients = "clients",
Options = new [] { "options" }
} }
} },
ReadOnly = false,
RecordSizeKiB = 123,
UserAndGroupQuotas = new [] { new UserAndGroupQuotasProperty {
Id = 123,
StorageCapacityQuotaGiB = 123,
Type = "type"
} }
},
RouteTableIds = new [] { "routeTableIds" },
ThroughputCapacity = 123,
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
};
Synopsis
Constructors
OpenZFSConfigurationProperty() |
Properties
AutomaticBackupRetentionDays | The number of days to retain automatic backups. |
CopyTagsToBackups | A Boolean value indicating whether tags for the file system should be copied to backups. |
CopyTagsToVolumes | A Boolean value indicating whether tags for the file system should be copied to volumes. |
DailyAutomaticBackupStartTime | A recurring daily time, in the format |
DeploymentType | Specifies the file system deployment type. |
DiskIopsConfiguration | The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. |
EndpointIpAddressRange | (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. |
Options | To delete a file system if there are child volumes present below the root volume, use the string |
PreferredSubnetId | Required when |
RootVolumeConfiguration | The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. |
RouteTableIds | (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. |
ThroughputCapacity | Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). |
WeeklyMaintenanceStartTime | A recurring weekly time, in the format |
Constructors
OpenZFSConfigurationProperty()
public OpenZFSConfigurationProperty()
Properties
AutomaticBackupRetentionDays
The number of days to retain automatic backups.
public Nullable<double> AutomaticBackupRetentionDays { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Setting this property to 0
disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30
.
CopyTagsToBackups
A Boolean value indicating whether tags for the file system should be copied to backups.
public object CopyTagsToBackups { get; set; }
Property Value
System.Object
Remarks
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.
CopyTagsToVolumes
A Boolean value indicating whether tags for the file system should be copied to volumes.
public object CopyTagsToVolumes { get; set; }
Property Value
System.Object
Remarks
This value defaults to false
. If it's set to true
, all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.
DailyAutomaticBackupStartTime
A recurring daily time, in the format HH:MM
.
public string DailyAutomaticBackupStartTime { get; set; }
Property Value
System.String
Remarks
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.
DeploymentType
Specifies the file system deployment type.
public string DeploymentType { get; set; }
Property Value
System.String
Remarks
Single AZ deployment types are configured for redundancy within a single Availability Zone in an AWS Region . Valid values are the following:
For more information, see Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide .
DiskIopsConfiguration
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.
public object DiskIopsConfiguration { get; set; }
Property Value
System.Object
Remarks
By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
EndpointIpAddressRange
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
public string EndpointIpAddressRange { get; set; }
Property Value
System.String
Remarks
By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
Options
To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
.
public string[] Options { get; set; }
Property Value
System.String[]
Remarks
If your file system has child volumes and you don't use this option, the delete request will fail.
PreferredSubnetId
Required when DeploymentType
is set to MULTI_AZ_1
.
public string PreferredSubnetId { get; set; }
Property Value
System.String
Remarks
This specifies the subnet in which you want the preferred file server to be located.
RootVolumeConfiguration
The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.
public object RootVolumeConfiguration { get; set; }
Property Value
System.Object
Remarks
All volumes are children of the root volume.
RouteTableIds
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
public string[] RouteTableIds { get; set; }
Property Value
System.String[]
Remarks
You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC's default route table.
ThroughputCapacity
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps).
public Nullable<double> ThroughputCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid values depend on the DeploymentType you choose, as follows:
You pay for additional throughput capacity that you provision.
WeeklyMaintenanceStartTime
A recurring weekly time, in the format D:HH:MM
.
public string WeeklyMaintenanceStartTime { get; set; }
Property Value
System.String
Remarks
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.