#[non_exhaustive]pub struct OntapFileSystemConfiguration {Show 13 fields
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>,
}
Expand description
Configuration for the FSx for NetApp ONTAP file system.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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
- 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.
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>
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.
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 ofDeploymentType
isSINGLE_AZ_1
,MULTI_AZ_1
, orMULTI_AZ_2
.
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
andMULTI_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
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is not a valid HA pair (a value between 1 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
Implementations§
Source§impl OntapFileSystemConfiguration
impl OntapFileSystemConfiguration
Sourcepub fn automatic_backup_retention_days(&self) -> Option<i32>
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
.
Sourcepub fn daily_automatic_backup_start_time(&self) -> Option<&str>
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.
Sourcepub fn deployment_type(&self) -> Option<&OntapDeploymentType>
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
- 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.
Sourcepub fn endpoint_ip_address_range(&self) -> Option<&str>
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.
Sourcepub fn endpoints(&self) -> Option<&FileSystemEndpoints>
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.
Sourcepub fn disk_iops_configuration(&self) -> Option<&DiskIopsConfiguration>
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.
Sourcepub fn preferred_subnet_id(&self) -> Option<&str>
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.
Sourcepub fn route_table_ids(&self) -> &[String]
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()
.
Sourcepub fn throughput_capacity(&self) -> Option<i32>
pub fn throughput_capacity(&self) -> Option<i32>
The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).
Sourcepub fn weekly_maintenance_start_time(&self) -> Option<&str>
pub fn weekly_maintenance_start_time(&self) -> Option<&str>
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.
Sourcepub fn fsx_admin_password(&self) -> Option<&str>
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.
Sourcepub fn ha_pairs(&self) -> Option<i32>
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 ofDeploymentType
isSINGLE_AZ_1
,MULTI_AZ_1
, orMULTI_AZ_2
.
Sourcepub fn throughput_capacity_per_ha_pair(&self) -> Option<i32>
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
andMULTI_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
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is not a valid HA pair (a value between 1 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
Source§impl OntapFileSystemConfiguration
impl OntapFileSystemConfiguration
Sourcepub fn builder() -> OntapFileSystemConfigurationBuilder
pub fn builder() -> OntapFileSystemConfigurationBuilder
Creates a new builder-style object to manufacture OntapFileSystemConfiguration
.
Trait Implementations§
Source§impl Clone for OntapFileSystemConfiguration
impl Clone for OntapFileSystemConfiguration
Source§fn clone(&self) -> OntapFileSystemConfiguration
fn clone(&self) -> OntapFileSystemConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for OntapFileSystemConfiguration
impl Debug for OntapFileSystemConfiguration
Source§impl PartialEq for OntapFileSystemConfiguration
impl PartialEq for OntapFileSystemConfiguration
Source§fn eq(&self, other: &OntapFileSystemConfiguration) -> bool
fn eq(&self, other: &OntapFileSystemConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for OntapFileSystemConfiguration
Auto Trait Implementations§
impl Freeze for OntapFileSystemConfiguration
impl RefUnwindSafe for OntapFileSystemConfiguration
impl Send for OntapFileSystemConfiguration
impl Sync for OntapFileSystemConfiguration
impl Unpin for OntapFileSystemConfiguration
impl UnwindSafe for OntapFileSystemConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);