Class CfnFileSystem.OntapConfigurationProperty
The configuration for this Amazon FSx for NetApp ONTAP file system.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class OntapConfigurationProperty : Object, CfnFileSystem.IOntapConfigurationProperty
Syntax (vb)
Public Class OntapConfigurationProperty
Inherits Object
Implements CfnFileSystem.IOntapConfigurationProperty
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 ontapConfigurationProperty = new OntapConfigurationProperty {
DeploymentType = "deploymentType",
// the properties below are optional
AutomaticBackupRetentionDays = 123,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DiskIopsConfiguration = new DiskIopsConfigurationProperty {
Iops = 123,
Mode = "mode"
},
EndpointIpAddressRange = "endpointIpAddressRange",
FsxAdminPassword = "fsxAdminPassword",
PreferredSubnetId = "preferredSubnetId",
RouteTableIds = new [] { "routeTableIds" },
ThroughputCapacity = 123,
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
};
Synopsis
Constructors
OntapConfigurationProperty() |
Properties
AutomaticBackupRetentionDays | The number of days to retain automatic backups. |
DailyAutomaticBackupStartTime | A recurring daily time, in the format |
DeploymentType | Specifies the FSx for ONTAP file system deployment type to use in creating the file system. |
DiskIopsConfiguration | The SSD IOPS configuration for the FSx for ONTAP file system. |
EndpointIpAddressRange | (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. |
FsxAdminPassword | The ONTAP administrative password for the |
PreferredSubnetId | Required when |
RouteTableIds | (Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created. |
ThroughputCapacity | Sets the throughput capacity for the file system that you're creating. |
WeeklyMaintenanceStartTime | A recurring weekly time, in the format |
Constructors
OntapConfigurationProperty()
public OntapConfigurationProperty()
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 0
.
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 FSx for ONTAP file system deployment type to use in creating the file system.
public string DeploymentType { get; set; }
Property Value
System.String
Remarks
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type .
DiskIopsConfiguration
The SSD IOPS configuration for the FSx for ONTAP file system.
public object DiskIopsConfiguration { get; set; }
Property Value
System.Object
Remarks
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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.
FsxAdminPassword
The ONTAP administrative password for the fsxadmin
user with which you administer your file system using the NetApp ONTAP CLI and REST API.
public string FsxAdminPassword { get; set; }
Property Value
System.String
Remarks
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.
RouteTableIds
(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created.
public string[] RouteTableIds { get; set; }
Property Value
System.String[]
Remarks
You should specify all 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
Sets the throughput capacity for the file system that you're creating.
public Nullable<double> ThroughputCapacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
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.