Documentation

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

See: newCreateFileSystemOntapConfiguration smart constructor.

Create a value of CreateFileSystemOntapConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:automaticBackupRetentionDays:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_automaticBackupRetentionDays - Undocumented member.

$sel:dailyAutomaticBackupStartTime:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_dailyAutomaticBackupStartTime - Undocumented member.

$sel:diskIopsConfiguration:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_diskIopsConfiguration - The SSD IOPS configuration for the FSx for ONTAP file system.

$sel:endpointIpAddressRange:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_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.

$sel:fsxAdminPassword:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_fsxAdminPassword - The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.

$sel:preferredSubnetId:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_preferredSubnetId - Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

$sel:routeTableIds:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_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.

$sel:weeklyMaintenanceStartTime:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_weeklyMaintenanceStartTime - Undocumented member.

$sel:deploymentType:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_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.

$sel:throughputCapacity:CreateFileSystemOntapConfiguration', createFileSystemOntapConfiguration_throughputCapacity - Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.

Undocumented member.

Undocumented member.

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

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

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

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

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

Undocumented member.

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.

Sets the throughput capacity for the file system that you're creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.