#[non_exhaustive]pub struct OntapFileSystemConfigurationBuilder { /* private fields */ }
Expand description
A builder for OntapFileSystemConfiguration
.
Implementations§
source§impl OntapFileSystemConfigurationBuilder
impl OntapFileSystemConfigurationBuilder
sourcepub fn automatic_backup_retention_days(self, input: i32) -> Self
pub fn automatic_backup_retention_days(self, input: i32) -> Self
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 set_automatic_backup_retention_days(self, input: Option<i32>) -> Self
pub fn set_automatic_backup_retention_days(self, input: Option<i32>) -> Self
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 get_automatic_backup_retention_days(&self) -> &Option<i32>
pub fn get_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, input: impl Into<String>) -> Self
pub fn daily_automatic_backup_start_time(self, input: impl Into<String>) -> Self
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 set_daily_automatic_backup_start_time(
self,
input: Option<String>
) -> Self
pub fn set_daily_automatic_backup_start_time( self, input: Option<String> ) -> Self
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 get_daily_automatic_backup_start_time(&self) -> &Option<String>
pub fn get_daily_automatic_backup_start_time(&self) -> &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.
sourcepub fn deployment_type(self, input: OntapDeploymentType) -> Self
pub fn deployment_type(self, input: OntapDeploymentType) -> Self
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.
sourcepub fn set_deployment_type(self, input: Option<OntapDeploymentType>) -> Self
pub fn set_deployment_type(self, input: Option<OntapDeploymentType>) -> Self
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.
sourcepub fn get_deployment_type(&self) -> &Option<OntapDeploymentType>
pub fn get_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.
sourcepub fn endpoint_ip_address_range(self, input: impl Into<String>) -> Self
pub fn endpoint_ip_address_range(self, input: impl Into<String>) -> Self
(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 set_endpoint_ip_address_range(self, input: Option<String>) -> Self
pub fn set_endpoint_ip_address_range(self, input: Option<String>) -> Self
(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 get_endpoint_ip_address_range(&self) -> &Option<String>
pub fn get_endpoint_ip_address_range(&self) -> &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.
sourcepub fn endpoints(self, input: FileSystemEndpoints) -> Self
pub fn endpoints(self, input: FileSystemEndpoints) -> Self
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 set_endpoints(self, input: Option<FileSystemEndpoints>) -> Self
pub fn set_endpoints(self, input: Option<FileSystemEndpoints>) -> Self
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 get_endpoints(&self) -> &Option<FileSystemEndpoints>
pub fn get_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, input: DiskIopsConfiguration) -> Self
pub fn disk_iops_configuration(self, input: DiskIopsConfiguration) -> Self
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
sourcepub fn set_disk_iops_configuration(
self,
input: Option<DiskIopsConfiguration>
) -> Self
pub fn set_disk_iops_configuration( self, input: Option<DiskIopsConfiguration> ) -> Self
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
sourcepub fn get_disk_iops_configuration(&self) -> &Option<DiskIopsConfiguration>
pub fn get_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, input: impl Into<String>) -> Self
pub fn preferred_subnet_id(self, input: impl Into<String>) -> Self
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 set_preferred_subnet_id(self, input: Option<String>) -> Self
pub fn set_preferred_subnet_id(self, input: Option<String>) -> Self
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 get_preferred_subnet_id(&self) -> &Option<String>
pub fn get_preferred_subnet_id(&self) -> &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.
sourcepub fn route_table_ids(self, input: impl Into<String>) -> Self
pub fn route_table_ids(self, input: impl Into<String>) -> Self
Appends an item to route_table_ids
.
To override the contents of this collection use set_route_table_ids
.
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
sourcepub fn set_route_table_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_route_table_ids(self, input: Option<Vec<String>>) -> Self
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
sourcepub fn get_route_table_ids(&self) -> &Option<Vec<String>>
pub fn get_route_table_ids(&self) -> &Option<Vec<String>>
(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
sourcepub fn throughput_capacity(self, input: i32) -> Self
pub fn throughput_capacity(self, input: i32) -> Self
The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).
sourcepub fn set_throughput_capacity(self, input: Option<i32>) -> Self
pub fn set_throughput_capacity(self, input: Option<i32>) -> Self
The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).
sourcepub fn get_throughput_capacity(&self) -> &Option<i32>
pub fn get_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, input: impl Into<String>) -> Self
pub fn weekly_maintenance_start_time(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_weekly_maintenance_start_time(self, input: Option<String>) -> Self
pub fn set_weekly_maintenance_start_time(self, input: Option<String>) -> Self
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.
sourcepub fn get_weekly_maintenance_start_time(&self) -> &Option<String>
pub fn get_weekly_maintenance_start_time(&self) -> &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.
sourcepub fn fsx_admin_password(self, input: impl Into<String>) -> Self
pub fn fsx_admin_password(self, input: impl Into<String>) -> Self
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 set_fsx_admin_password(self, input: Option<String>) -> Self
pub fn set_fsx_admin_password(self, input: Option<String>) -> Self
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 get_fsx_admin_password(&self) -> &Option<String>
pub fn get_fsx_admin_password(&self) -> &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.
sourcepub fn ha_pairs(self, input: i32) -> Self
pub fn ha_pairs(self, input: i32) -> Self
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
orMULTI_AZ_1
.
sourcepub fn set_ha_pairs(self, input: Option<i32>) -> Self
pub fn set_ha_pairs(self, input: Option<i32>) -> Self
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
orMULTI_AZ_1
.
sourcepub fn get_ha_pairs(&self) -> &Option<i32>
pub fn get_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
orMULTI_AZ_1
.
sourcepub fn throughput_capacity_per_ha_pair(self, input: i32) -> Self
pub fn throughput_capacity_per_ha_pair(self, input: i32) -> Self
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
, 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
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is a valid HA pair (a value between 2 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
sourcepub fn set_throughput_capacity_per_ha_pair(self, input: Option<i32>) -> Self
pub fn set_throughput_capacity_per_ha_pair(self, input: Option<i32>) -> Self
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
, 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
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is a valid HA pair (a value between 2 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
sourcepub fn get_throughput_capacity_per_ha_pair(&self) -> &Option<i32>
pub fn get_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
, 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
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is a valid HA pair (a value between 2 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
sourcepub fn build(self) -> OntapFileSystemConfiguration
pub fn build(self) -> OntapFileSystemConfiguration
Consumes the builder and constructs a OntapFileSystemConfiguration
.
Trait Implementations§
source§impl Clone for OntapFileSystemConfigurationBuilder
impl Clone for OntapFileSystemConfigurationBuilder
source§fn clone(&self) -> OntapFileSystemConfigurationBuilder
fn clone(&self) -> OntapFileSystemConfigurationBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for OntapFileSystemConfigurationBuilder
impl Default for OntapFileSystemConfigurationBuilder
source§fn default() -> OntapFileSystemConfigurationBuilder
fn default() -> OntapFileSystemConfigurationBuilder
source§impl PartialEq for OntapFileSystemConfigurationBuilder
impl PartialEq for OntapFileSystemConfigurationBuilder
source§fn eq(&self, other: &OntapFileSystemConfigurationBuilder) -> bool
fn eq(&self, other: &OntapFileSystemConfigurationBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.