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
, "PreferredSubnetId" :String
, "RouteTableIds" :[ String, ... ]
, "ThroughputCapacity" :Integer
, "WeeklyMaintenanceStartTime" :String
}
YAML
AutomaticBackupRetentionDays:
Integer
DailyAutomaticBackupStartTime:String
DeploymentType:String
DiskIopsConfiguration:DiskIopsConfiguration
EndpointIpAddressRange:String
FsxAdminPassword:String
PreferredSubnetId:String
RouteTableIds:- String
ThroughputCapacity: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 is0
.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
- (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.
Required: Yes
Type: String
Allowed values:
MULTI_AZ_1 | SINGLE_AZ_1
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.
Required: No
Type: String
Minimum:
9
Maximum:
17
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{9,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
Minimum:
8
Maximum:
50
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$
Update requires: No interruption
PreferredSubnetId
-
Required when
DeploymentType
is set toMULTI_AZ_1
. 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 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.
Required: No
Type: List of String
Maximum:
50
Update requires: No interruption
ThroughputCapacity
-
Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
Required: No
Type: Integer
Minimum:
8
Maximum:
100000
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