Table of Contents

Class OntapFileSystemConfiguration

Namespace
Amazon.FSx.Model
Assembly
AWSSDK.FSx.dll

Configuration for the FSx for NetApp ONTAP file system.

public class OntapFileSystemConfiguration
Inheritance
OntapFileSystemConfiguration
Inherited Members

Constructors

OntapFileSystemConfiguration() 

public OntapFileSystemConfiguration()

Properties

AutomaticBackupRetentionDays

Gets and sets the property AutomaticBackupRetentionDays.

public int AutomaticBackupRetentionDays { get; set; }

Property Value

int

DailyAutomaticBackupStartTime

Gets and sets the property DailyAutomaticBackupStartTime.

public string DailyAutomaticBackupStartTime { get; set; }

Property Value

string

DeploymentType

Gets and sets the property DeploymentType.

Specifies the FSx for ONTAP file system deployment type in use in 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 Multi-AZ or Single-AZ file system deployment. 

public OntapDeploymentType DeploymentType { get; set; }

Property Value

OntapDeploymentType

DiskIopsConfiguration

Gets and sets the property DiskIopsConfiguration.

The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. 

public DiskIopsConfiguration DiskIopsConfiguration { get; set; }

Property Value

DiskIopsConfiguration

EndpointIpAddressRange

Gets and sets the property 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. 

public string EndpointIpAddressRange { get; set; }

Property Value

string

Endpoints

Gets and sets the property Endpoints.

The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. 

public FileSystemEndpoints Endpoints { get; set; }

Property Value

FileSystemEndpoints

FsxAdminPassword

Gets and sets the property FsxAdminPassword.

You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. 

public string FsxAdminPassword { get; set; }

Property Value

string

HAPairs

Gets and sets the property HAPairs.

Specifies how many high-availability (HA) file server pairs the file system will have. 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.

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. 

public int HAPairs { get; set; }

Property Value

int

PreferredSubnetId

Gets and sets the property PreferredSubnetId.

public string PreferredSubnetId { get; set; }

Property Value

string

RouteTableIds

Gets and sets the property RouteTableIds.

(Multi-AZ only) The VPC route tables in which your file system's endpoints are created. 

public List<string> RouteTableIds { get; set; }

Property Value

List<string>

ThroughputCapacity

Gets and sets the property ThroughputCapacity.

public int ThroughputCapacity { get; set; }

Property Value

int

ThroughputCapacityPerHAPair

Gets and sets the property ThroughputCapacityPerHAPair.

Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

This field and ThroughputCapacity are the same for file systems with 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.

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

public int ThroughputCapacityPerHAPair { get; set; }

Property Value

int

WeeklyMaintenanceStartTime

Gets and sets the property WeeklyMaintenanceStartTime.

public string WeeklyMaintenanceStartTime { get; set; }

Property Value

string