CreateFileSystemOntapConfiguration
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
Contents
- AutomaticBackupRetentionDays
-
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 is0
.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 90.
Required: No
- DailyAutomaticBackupStartTime
-
A recurring daily time, in the format
HH:MM
.HH
is the zero-padded hour of the day (0-23), andMM
is the zero-padded minute of the hour. For example,05:00
specifies 5 AM daily.Type: String
Length Constraints: Fixed length of 5.
Pattern:
^([01]\d|2[0-3]):?([0-5]\d)$
Required: No
- DeploymentType
-
Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
-
MULTI_AZ_1
- (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. -
SINGLE_AZ_1
- A file system configured for Single-AZ redundancy.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.
Type: String
Valid Values:
MULTI_AZ_1 | SINGLE_AZ_1
Required: Yes
-
- DiskIopsConfiguration
-
The SSD IOPS configuration for the FSx for ONTAP file system.
Type: DiskIopsConfiguration object
Required: No
- EndpointIpAddressRange
-
(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. 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.
Type: String
Length Constraints: Minimum length of 9. Maximum length of 17.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{9,17}$
Required: No
- FsxAdminPassword
-
The ONTAP administrative password for the
fsxadmin
user with which you administer your file system using the NetApp ONTAP CLI and REST API.Type: String
Length Constraints: Minimum length of 8. Maximum length of 50.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$
Required: No
- PreferredSubnetId
-
Required when
DeploymentType
is set toMULTI_AZ_1
. This specifies the subnet in which you want the preferred file server to be located.Type: String
Length Constraints: Minimum length of 15. Maximum length of 24.
Pattern:
^(subnet-[0-9a-f]{8,})$
Required: No
- RouteTableIds
-
(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system's endpoints will be created. 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.
Type: Array of strings
Array Members: Maximum number of 50 items.
Length Constraints: Minimum length of 12. Maximum length of 21.
Pattern:
^(rtb-[0-9a-f]{8,})$
Required: No
- ThroughputCapacity
-
Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
Type: Integer
Valid Range: Minimum value of 8. Maximum value of 100000.
Required: Yes
- WeeklyMaintenanceStartTime
-
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), andMM
is the zero-padded minute of the hour.For example,
1:05:00
specifies maintenance at 5 AM Monday.Type: String
Length Constraints: Fixed length of 7.
Pattern:
^[1-7]:([01]\d|2[0-3]):?([0-5]\d)$
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: