Struct aws_sdk_fsx::types::OntapFileSystemConfiguration

#[non_exhaustive]
pub struct OntapFileSystemConfiguration {

    pub automatic_backup_retention_days: Option<i32>,
    pub daily_automatic_backup_start_time: Option<String>,
    pub deployment_type: Option<OntapDeploymentType>,
    pub endpoint_ip_address_range: Option<String>,
    pub endpoints: Option<FileSystemEndpoints>,
    pub disk_iops_configuration: Option<DiskIopsConfiguration>,
    pub preferred_subnet_id: Option<String>,
    pub route_table_ids: Option<Vec<String>>,
    pub throughput_capacity: Option<i32>,
    pub weekly_maintenance_start_time: Option<String>,
    pub fsx_admin_password: Option<String>,
    pub ha_pairs: Option<i32>,
    pub throughput_capacity_per_ha_pair: Option<i32>,
}

Configuration for the FSx for NetApp ONTAP file system.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

automatic_backup_retention_days: Option<i32>

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.

daily_automatic_backup_start_time: Option<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.

deployment_type: Option<OntapDeploymentType>

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

• SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

endpoint_ip_address_range: Option<String>

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

endpoints: Option<FileSystemEndpoints>

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.

disk_iops_configuration: Option<DiskIopsConfiguration>

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

preferred_subnet_id: Option<String>

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

route_table_ids: Option<Vec<String>>

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

throughput_capacity: Option<i32>

The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

weekly_maintenance_start_time: Option<String>

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), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

fsx_admin_password: Option<String>

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.

ha_pairs: Option<i32>

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 or MULTI_AZ_1.

throughput_capacity_per_ha_pair: Option<i32>

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, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

• For SINGLE_AZ_2, valid values are 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 a valid HA pair (a value between 2 and 12).

• The value of ThroughputCapacityPerHAPair is not a valid value.

Implementations

impl OntapFileSystemConfiguration

pub fn automatic_backup_retention_days(&self) -> Option<i32>

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.

pub fn daily_automatic_backup_start_time(&self) -> Option<&str>

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.

pub fn deployment_type(&self) -> Option<&OntapDeploymentType>

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

• SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

pub fn endpoint_ip_address_range(&self) -> Option<&str>

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

pub fn endpoints(&self) -> Option<&FileSystemEndpoints>

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.

pub fn disk_iops_configuration(&self) -> Option<&DiskIopsConfiguration>

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

pub fn preferred_subnet_id(&self) -> Option<&str>

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

pub fn route_table_ids(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .route_table_ids.is_none().

pub fn throughput_capacity(&self) -> Option<i32>

The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

pub fn weekly_maintenance_start_time(&self) -> Option<&str>

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), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

pub fn fsx_admin_password(&self) -> Option<&str>

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.

pub fn ha_pairs(&self) -> Option<i32>

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 or MULTI_AZ_1.

pub fn throughput_capacity_per_ha_pair(&self) -> Option<i32>

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, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

• For SINGLE_AZ_2, valid values are 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 a valid HA pair (a value between 2 and 12).

• The value of ThroughputCapacityPerHAPair is not a valid value.

impl OntapFileSystemConfiguration

pub fn builder() -> OntapFileSystemConfigurationBuilder

Creates a new builder-style object to manufacture OntapFileSystemConfiguration.

Trait Implementations

impl Clone for OntapFileSystemConfiguration

fn clone(&self) -> OntapFileSystemConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OntapFileSystemConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OntapFileSystemConfiguration

fn eq(&self, other: &OntapFileSystemConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OntapFileSystemConfiguration