AWS::FSx::FileSystem OntapConfiguration
The configuration for this Amazon FSx for NetApp ONTAP file system.
Syntax
To declare this entity in your Amazon 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:
Integer
DailyAutomaticBackupStartTime:String
DeploymentType:String
DiskIopsConfiguration:DiskIopsConfiguration
EndpointIpAddressRange:String
FsxAdminPassword:String
HAPairs:Integer
PreferredSubnetId:String
RouteTableIds:- String
ThroughputCapacity:Integer
ThroughputCapacityPerHAPair:Integer
WeeklyMaintenanceStartTime:String
Properties
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 is30
.Required: No
Type: Integer
Update requires: No interruption
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.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_2
Update 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 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, as long as they don't overlap with any subnet.
Required: No
Type: String
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{9,17}$
Minimum:
9
Maximum:
17
Update requires: Replacement
FsxAdminPassword
-
The ONTAP administrative password for the
fsxadmin
user 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:
8
Maximum:
50
Update 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
HAPairs
is less than 1 or greater than 12. -
The value of
HAPairs
is greater than 1 and the value ofDeploymentType
isSINGLE_AZ_1
,MULTI_AZ_1
, orMULTI_AZ_2
.
Required: No
Type: Integer
Minimum:
1
Maximum:
12
Update requires: No interruption
-
PreferredSubnetId
-
Required when
DeploymentType
is set toMULTI_AZ_1
orMULTI_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 Amazon CloudFormation we recommend that you add theKey: AmazonFSx; Value: ManagedByAmazonFSx
tag manually.Required: No
Type: Array of String
Maximum:
50
Update 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
ThroughputCapacity
andThroughputCapacityPerHAPair
are not the same value. -
The value of
ThroughputCapacity
when divided by the value ofHAPairs
is outside of the valid range forThroughputCapacity
.
Required: No
Type: Integer
Minimum:
8
Maximum:
100000
Update 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
ThroughputCapacityPerHAPair
or theThroughputCapacity
when creating a file system, but not both.This field and
ThroughputCapacity
are the same for file systems powered by one HA pair.-
For
SINGLE_AZ_1
andMULTI_AZ_1
file 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
ThroughputCapacity
andThroughputCapacityPerHAPair
are not the same value for file systems with one HA pair. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is not a valid HA pair (a value between 1 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
Required: No
Type: Integer
Minimum:
128
Maximum:
6144
Update requires: No interruption
-
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.Required: No
Type: String
Update requires: No interruption