aws-cdk-lib.aws_fsx.CfnFileSystem.OntapConfigurationProperty

OntapConfigurationProperty Struct

The configuration for this Amazon FSx for NetApp ONTAP file system.

Source

Generated code

Type last changed

v2.223.0 · 10 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_fsx as fsx } from 'aws-cdk-lib';
const ontapConfigurationProperty: fsx.CfnFileSystem.OntapConfigurationProperty = {
  deploymentType: 'deploymentType',

  // the properties below are optional
  automaticBackupRetentionDays: 123,
  dailyAutomaticBackupStartTime: 'dailyAutomaticBackupStartTime',
  diskIopsConfiguration: {
    iops: 123,
    mode: 'mode',
  },
  endpointIpAddressRange: 'endpointIpAddressRange',
  endpointIpv6AddressRange: 'endpointIpv6AddressRange',
  fsxAdminPassword: 'fsxAdminPassword',
  haPairs: 123,
  preferredSubnetId: 'preferredSubnetId',
  routeTableIds: ['routeTableIds'],
  throughputCapacity: 123,
  throughputCapacityPerHaPair: 123,
  weeklyMaintenanceStartTime: 'weeklyMaintenanceStartTime',
};

Properties

automaticBackupRetentionDays?optionalnumberautomatic_backup_retention_days?optionalint | floatautomaticBackupRetentionDays?optionalNumberAutomaticBackupRetentionDays?optionaldoubleAutomaticBackupRetentionDays?optional*float64#

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 is 30 .

dailyAutomaticBackupStartTime?optionalstringdaily_automatic_backup_start_time?optionalstrdailyAutomaticBackupStartTime?optionalStringDailyAutomaticBackupStartTime?optionalstringDailyAutomaticBackupStartTime?optional*string#

A recurring daily time, in the format `HH:MM` .

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.

deploymentTypestringdeployment_typestrdeploymentTypeStringDeploymentTypestringDeploymentType*stringrequired#

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

notes

• 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 .

diskIopsConfiguration?optionalIResolvable | CfnFileSystem.DiskIopsConfigurationPropertydisk_iops_configuration?optionaltyping.Union[IResolvable, DiskIopsConfigurationProperty]diskIopsConfiguration?optionalIResolvableDiskIopsConfiguration?optionalIResolvableDiskIopsConfiguration?optionalinterface{}#

The SSD IOPS configuration for the FSx for ONTAP file system.

endpointIpAddressRange?optionalstringendpoint_ip_address_range?optionalstrendpointIpAddressRange?optionalStringEndpointIpAddressRange?optionalstringEndpointIpAddressRange?optional*string#

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created.

notes

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.

endpointIpv6AddressRange?optionalstringendpoint_ipv6_address_range?optionalstrendpointIpv6AddressRange?optionalStringEndpointIpv6AddressRange?optionalstringEndpointIpv6AddressRange?optional*string#

fsxAdminPassword?optionalstringfsx_admin_password?optionalstrfsxAdminPassword?optionalStringFsxAdminPassword?optionalstringFsxAdminPassword?optional*string#

The ONTAP administrative password for the `fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API.

haPairs?optionalnumberha_pairs?optionalint | floathaPairs?optionalNumberHaPairs?optionaldoubleHaPairs?optional*float64#

Specifies how many high-availability (HA) pairs of file servers will power your file system.

notes

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 , and ThroughputCapacity . 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 of DeploymentType is SINGLE_AZ_1 , MULTI_AZ_1 , or MULTI_AZ_2 .

preferredSubnetId?optionalstringpreferred_subnet_id?optionalstrpreferredSubnetId?optionalStringPreferredSubnetId?optionalstringPreferredSubnetId?optional*string#

Required when `DeploymentType` is set to `MULTI_AZ_1` or `MULTI_AZ_2` .

This specifies the subnet in which you want the preferred file server to be located.

routeTableIds?optionalstring[]route_table_ids?optionaltyping.List[str]routeTableIds?optionalList<String>RouteTableIds?optionalstring[]RouteTableIds?optional*[]*string#

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.

notes

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 CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.

throughputCapacity?optionalnumberthroughput_capacity?optionalint | floatthroughputCapacity?optionalNumberThroughputCapacity?optionaldoubleThroughputCapacity?optional*float64#

Sets the throughput capacity for the file system that you're creating in megabytes per second (MBps).

notes

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 and ThroughputCapacityPerHAPair are not the same value.
• The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity .

throughputCapacityPerHaPair?optionalnumberthroughput_capacity_per_ha_pair?optionalint | floatthroughputCapacityPerHaPair?optionalNumberThroughputCapacityPerHaPair?optionaldoubleThroughputCapacityPerHaPair?optional*float64#

Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

notes

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 file systems powered by one HA pair.

• For SINGLE_AZ_1 and MULTI_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 and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
• The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).
• The value of ThroughputCapacityPerHAPair is not a valid value.

weeklyMaintenanceStartTime?optionalstringweekly_maintenance_start_time?optionalstrweeklyMaintenanceStartTime?optionalStringWeeklyMaintenanceStartTime?optionalstringWeeklyMaintenanceStartTime?optional*string#

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:00 specifies maintenance at 5 AM Monday.