This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::FSx::FileSystem OntapConfiguration
The configuration for this Amazon FSx for NetApp ONTAP file system.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AutomaticBackupRetentionDays" :Integer, "DailyAutomaticBackupStartTime" :String, "DeploymentType" :String, "DiskIopsConfiguration" :DiskIopsConfiguration, "EndpointIpAddressRange" :String, "FsxAdminPassword" :String, "HAPairs" :Integer, "PreferredSubnetId" :String, "RouteTableIds" :[ String, ... ], "ThroughputCapacity" :Integer, "ThroughputCapacityPerHAPair" :Integer, "WeeklyMaintenanceStartTime" :String}
YAML
AutomaticBackupRetentionDays:IntegerDailyAutomaticBackupStartTime:StringDeploymentType:StringDiskIopsConfiguration:DiskIopsConfigurationEndpointIpAddressRange:StringFsxAdminPassword:StringHAPairs:IntegerPreferredSubnetId:StringRouteTableIds:- StringThroughputCapacity:IntegerThroughputCapacityPerHAPair:IntegerWeeklyMaintenanceStartTime:String
Properties
AutomaticBackupRetentionDays-
The number of days to retain automatic backups. Setting this property to
0disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is30.Required: No
Type: Integer
Update requires: No interruption
DailyAutomaticBackupStartTime-
A recurring daily time, in the format
HH:MM.HHis the zero-padded hour of the day (0-23), andMMis the zero-padded minute of the hour. For example,05:00specifies 5 AM daily.Required: No
Type: String
Update requires: No interruption
DeploymentType-
Specifies the FSx for ONTAP file system deployment type to use in creating the file system.
-
MULTI_AZ_1- A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. -
MULTI_AZ_2- A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. -
SINGLE_AZ_1- A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. -
SINGLE_AZ_2- A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.
For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type.
Required: Yes
Type: String
Allowed values:
MULTI_AZ_1 | SINGLE_AZ_1 | SINGLE_AZ_2 | MULTI_AZ_2Update requires: Replacement
-
DiskIopsConfiguration-
The SSD IOPS configuration for the FSx for ONTAP file system.
Required: No
Type: DiskIopsConfiguration
Update requires: No interruption
EndpointIpAddressRange-
(Multi-AZ only) Specifies the IPv4 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, as long as they don't overlap with any subnet.
Required: No
Type: String
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{9,17}$Minimum:
9Maximum:
17Update requires: Replacement
FsxAdminPassword-
The ONTAP administrative password for the
fsxadminuser with which you administer your file system using the NetApp ONTAP CLI and REST API.Required: No
Type: String
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$Minimum:
8Maximum:
50Update requires: No interruption
HAPairs-
Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of
StorageCapacity,Iops, andThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
-
The value of
HAPairsis less than 1 or greater than 12. -
The value of
HAPairsis greater than 1 and the value ofDeploymentTypeisSINGLE_AZ_1,MULTI_AZ_1, orMULTI_AZ_2.
Required: No
Type: Integer
Minimum:
1Maximum:
12Update requires: No interruption
-
PreferredSubnetId-
Required when
DeploymentTypeis set toMULTI_AZ_1orMULTI_AZ_2. This specifies the subnet in which you want the preferred file server to be located.Required: No
Type: String
Update requires: Replacement
RouteTableIds-
(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. 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.
Note
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 theKey: AmazonFSx; Value: ManagedByAmazonFSxtag manually.Required: No
Type: Array of String
Maximum:
50Update requires: No interruption
ThroughputCapacity-
Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps). 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:
-
The value of
ThroughputCapacityandThroughputCapacityPerHAPairare not the same value. -
The value of
ThroughputCapacitywhen divided by the value ofHAPairsis outside of the valid range forThroughputCapacity.
Required: No
Type: Integer
Minimum:
8Maximum:
100000Update requires: No interruption
-
ThroughputCapacityPerHAPair-
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
You can define either the
ThroughputCapacityPerHAPairor theThroughputCapacitywhen creating a file system, but not both.This field and
ThroughputCapacityare the same for file systems powered by one HA pair.-
For
SINGLE_AZ_1andMULTI_AZ_1file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. -
For
SINGLE_AZ_2, valid values are 1536, 3072, or 6144 MBps. -
For
MULTI_AZ_2, valid values are 384, 768, 1536, 3072, or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
-
The value of
ThroughputCapacityandThroughputCapacityPerHAPairare not the same value for file systems with one HA pair. -
The value of deployment type is
SINGLE_AZ_2andThroughputCapacity/ThroughputCapacityPerHAPairis not a valid HA pair (a value between 1 and 12). -
The value of
ThroughputCapacityPerHAPairis not a valid value.
Required: No
Type: Integer
Minimum:
128Maximum:
6144Update requires: No interruption
-
WeeklyMaintenanceStartTime-
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
For example,
1:05:00specifies maintenance at 5 AM Monday.Required: No
Type: String
Update requires: No interruption
