Interface CfnFileSystem.IOntapConfigurationProperty
The configuration for this Amazon FSx for NetApp ONTAP file system.
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IOntapConfigurationProperty
Syntax (vb)
Public Interface 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",
HaPairs = 123,
PreferredSubnetId = "preferredSubnetId",
RouteTableIds = new [] { "routeTableIds" },
ThroughputCapacity = 123,
ThroughputCapacityPerHaPair = 123,
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
};
Synopsis
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 |
HaPairs | Specifies how many high-availability (HA) pairs of file servers will power your file system. |
PreferredSubnetId | Required when |
RouteTableIds | (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. |
ThroughputCapacity | Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). |
ThroughputCapacityPerHaPair | Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system. |
WeeklyMaintenanceStartTime | A recurring weekly time, in the format |
Properties
AutomaticBackupRetentionDays
The number of days to retain automatic backups.
virtual Nullable<double> AutomaticBackupRetentionDays { get; }
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
.
DailyAutomaticBackupStartTime
A recurring daily time, in the format HH:MM
.
virtual string DailyAutomaticBackupStartTime { get; }
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.
string DeploymentType { get; }
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.
virtual object DiskIopsConfiguration { get; }
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.
virtual string EndpointIpAddressRange { get; }
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.
virtual string FsxAdminPassword { get; }
Property Value
System.String
Remarks
HaPairs
Specifies how many high-availability (HA) pairs of file servers will power your file system.
virtual Nullable<double> HaPairs { get; }
Property Value
System.Nullable<System.Double>
Remarks
Scale-up file systems are powered by 1 HA pair. The default value is 1. FSx for ONTAP scale-out file systems are powered by up to 12 HA pairs. The value of this property affects the values of StorageCapacity
, Iops
, and ThroughputCapacity
. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
PreferredSubnetId
Required when DeploymentType
is set to MULTI_AZ_1
.
virtual string PreferredSubnetId { get; }
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 route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.
virtual string[] RouteTableIds { get; }
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.
Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx
. When creating FSx for ONTAP Multi-AZ file systems using AWS CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx
tag manually.
ThroughputCapacity
Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).
virtual Nullable<double> ThroughputCapacity { get; }
Property Value
System.Nullable<System.Double>
Remarks
For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
ThroughputCapacityPerHaPair
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
virtual Nullable<double> ThroughputCapacityPerHaPair { get; }
Property Value
System.Nullable<System.Double>
Remarks
You can define either the ThroughputCapacityPerHAPair
or the ThroughputCapacity
when creating a file system, but not both.
This field and ThroughputCapacity
are the same for scale-up file systems powered by one HA pair.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
WeeklyMaintenanceStartTime
A recurring weekly time, in the format D:HH:MM
.
virtual string WeeklyMaintenanceStartTime { get; }
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.