/AWS1/CL_FSXUPFILESYSTEMOPEN00¶
The configuration updates for an Amazon FSx for OpenZFS file system.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_automaticbackupretdays TYPE /AWS1/FSXAUTOMATICBACKUPRETD00 /AWS1/FSXAUTOMATICBACKUPRETD00¶
The number of days to retain automatic backups. Setting this property to
0disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is30.
iv_copytagstobackups TYPE /AWS1/FSXFLAG /AWS1/FSXFLAG¶
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to
false. If it's set totrue, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value istrueand you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
iv_copytagstovolumes TYPE /AWS1/FSXFLAG /AWS1/FSXFLAG¶
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false. If it's set totrue, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value istrueand you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
iv_dailyautomaticbackupstr00 TYPE /AWS1/FSXDAILYTIME /AWS1/FSXDAILYTIME¶
A recurring daily time, in the format
HH:MM.HHis the zero-padded hour of the day (0-23), andMMis the zero-padded minute of the hour. For example,05:00specifies 5 AM daily.
iv_throughputcapacity TYPE /AWS1/FSXMEGABYTESPERSECOND /AWS1/FSXMEGABYTESPERSECOND¶
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second
 (MB/s). Valid values depend on the DeploymentType you choose, as follows:
For
MULTI_AZ_1andSINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.For
SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
iv_weeklymaintenancestrttime TYPE /AWS1/FSXWEEKLYTIME /AWS1/FSXWEEKLYTIME¶
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:00specifies maintenance at 5 AM Monday.
io_diskiopsconfiguration TYPE REF TO /AWS1/CL_FSXDISKIOPSCONF /AWS1/CL_FSXDISKIOPSCONF¶
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
it_addroutetableids TYPE /AWS1/CL_FSXROUTETABLEIDS_W=>TT_ROUTETABLEIDS TT_ROUTETABLEIDS¶
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for OpenZFS file system.
it_removeroutetableids TYPE /AWS1/CL_FSXROUTETABLEIDS_W=>TT_ROUTETABLEIDS TT_ROUTETABLEIDS¶
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
io_readcacheconfiguration TYPE REF TO /AWS1/CL_FSXOPENZFSREADCACHE00 /AWS1/CL_FSXOPENZFSREADCACHE00¶
The configuration for the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.
iv_endpointipv6addressrange TYPE /AWS1/FSXIPV6ADDRESSRANGE /AWS1/FSXIPV6ADDRESSRANGE¶
(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.
Queryable Attributes¶
AutomaticBackupRetentionDays¶
The number of days to retain automatic backups. Setting this property to
0disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is30.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTOMATICBACKUPRETDAYS() |
Getter for AUTOMATICBACKUPRETENTIONDAYS, with configurable d |
ASK_AUTOMATICBACKUPRETDAYS() |
Getter for AUTOMATICBACKUPRETENTIONDAYS w/ exceptions if fie |
HAS_AUTOMATICBACKUPRETDAYS() |
Determine if AUTOMATICBACKUPRETENTIONDAYS has a value |
CopyTagsToBackups¶
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to
false. If it's set totrue, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value istrueand you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COPYTAGSTOBACKUPS() |
Getter for COPYTAGSTOBACKUPS, with configurable default |
ASK_COPYTAGSTOBACKUPS() |
Getter for COPYTAGSTOBACKUPS w/ exceptions if field has no v |
HAS_COPYTAGSTOBACKUPS() |
Determine if COPYTAGSTOBACKUPS has a value |
CopyTagsToVolumes¶
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false. If it's set totrue, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value istrueand you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COPYTAGSTOVOLUMES() |
Getter for COPYTAGSTOVOLUMES, with configurable default |
ASK_COPYTAGSTOVOLUMES() |
Getter for COPYTAGSTOVOLUMES w/ exceptions if field has no v |
HAS_COPYTAGSTOVOLUMES() |
Determine if COPYTAGSTOVOLUMES has a value |
DailyAutomaticBackupStartTime¶
A recurring daily time, in the format
HH:MM.HHis the zero-padded hour of the day (0-23), andMMis the zero-padded minute of the hour. For example,05:00specifies 5 AM daily.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DAILYAUTOMATICBACKUPST00() |
Getter for DAILYAUTOMATICBACKUPSTRTTIME, with configurable d |
ASK_DAILYAUTOMATICBACKUPST00() |
Getter for DAILYAUTOMATICBACKUPSTRTTIME w/ exceptions if fie |
HAS_DAILYAUTOMATICBACKUPST00() |
Determine if DAILYAUTOMATICBACKUPSTRTTIME has a value |
ThroughputCapacity¶
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second
 (MB/s). Valid values depend on the DeploymentType you choose, as follows:
For
MULTI_AZ_1andSINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.For
SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_THROUGHPUTCAPACITY() |
Getter for THROUGHPUTCAPACITY, with configurable default |
ASK_THROUGHPUTCAPACITY() |
Getter for THROUGHPUTCAPACITY w/ exceptions if field has no |
HAS_THROUGHPUTCAPACITY() |
Determine if THROUGHPUTCAPACITY has a value |
WeeklyMaintenanceStartTime¶
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:00specifies maintenance at 5 AM Monday.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_WEEKLYMAINTENANCESTRTT00() |
Getter for WEEKLYMAINTENANCESTARTTIME, with configurable def |
ASK_WEEKLYMAINTENANCESTRTT00() |
Getter for WEEKLYMAINTENANCESTARTTIME w/ exceptions if field |
HAS_WEEKLYMAINTENANCESTRTT00() |
Determine if WEEKLYMAINTENANCESTARTTIME has a value |
DiskIopsConfiguration¶
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISKIOPSCONFIGURATION() |
Getter for DISKIOPSCONFIGURATION |
AddRouteTableIds¶
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for OpenZFS file system.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ADDROUTETABLEIDS() |
Getter for ADDROUTETABLEIDS, with configurable default |
ASK_ADDROUTETABLEIDS() |
Getter for ADDROUTETABLEIDS w/ exceptions if field has no va |
HAS_ADDROUTETABLEIDS() |
Determine if ADDROUTETABLEIDS has a value |
RemoveRouteTableIds¶
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for OpenZFS file system. You can use the API operation to retrieve the list of VPC route table IDs for a file system.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REMOVEROUTETABLEIDS() |
Getter for REMOVEROUTETABLEIDS, with configurable default |
ASK_REMOVEROUTETABLEIDS() |
Getter for REMOVEROUTETABLEIDS w/ exceptions if field has no |
HAS_REMOVEROUTETABLEIDS() |
Determine if REMOVEROUTETABLEIDS has a value |
ReadCacheConfiguration¶
The configuration for the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_READCACHECONFIGURATION() |
Getter for READCACHECONFIGURATION |
EndpointIpv6AddressRange¶
(Multi-AZ only) Specifies the IPv6 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don't overlap with any subnet.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINTIPV6ADDRESSRANGE() |
Getter for ENDPOINTIPV6ADDRESSRANGE, with configurable defau |
ASK_ENDPOINTIPV6ADDRESSRANGE() |
Getter for ENDPOINTIPV6ADDRESSRANGE w/ exceptions if field h |
HAS_ENDPOINTIPV6ADDRESSRANGE() |
Determine if ENDPOINTIPV6ADDRESSRANGE has a value |