aws-sdk-fsx 1.80.0 → 1.81.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -70,7 +70,7 @@ module Aws::FSx
70
70
  end
71
71
 
72
72
  # Describes a specific Amazon FSx administrative action for the current
73
- # Windows, Lustre, or OpenZFS file system.
73
+ # Windows, Lustre, OpenZFS, or ONTAP file system or volume.
74
74
  #
75
75
  # @!attribute [rw] administrative_action_type
76
76
  # Describes the type of administrative action, as follows:
@@ -126,8 +126,8 @@ module Aws::FSx
126
126
  # `ProgressPercent` property. When `IOPS_OPTIMIZATION` has been
127
127
  # completed successfully, the parent `FILE_SYSTEM_UPDATE` action
128
128
  # status changes to `COMPLETED`. For more information, see [Managing
129
- # provisioned SSD IOPS][7] in the *Amazon FSx for Windows File
130
- # Server User Guide*.
129
+ # provisioned SSD IOPS][7] in the Amazon FSx for Windows File Server
130
+ # User Guide.
131
131
  #
132
132
  # * `STORAGE_TYPE_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task
133
133
  # to increase a file system's throughput capacity has been
@@ -138,9 +138,9 @@ module Aws::FSx
138
138
  # been completed successfully, the parent `FILE_SYSTEM_UPDATE`
139
139
  # action status changes to `COMPLETED`.
140
140
  #
141
- # * `VOLUME_UPDATE` - A volume update to an Amazon FSx for NetApp
142
- # ONTAP or Amazon FSx for OpenZFS volume initiated from the Amazon
143
- # FSx console, API (`UpdateVolume`), or CLI (`update-volume`).
141
+ # * `VOLUME_UPDATE` - A volume update to an Amazon FSx for OpenZFS
142
+ # volume initiated from the Amazon FSx console, API
143
+ # (`UpdateVolume`), or CLI (`update-volume`).
144
144
  #
145
145
  # * `VOLUME_RESTORE` - An Amazon FSx for OpenZFS volume is returned to
146
146
  # the state saved by the specified snapshot, initiated from an API
@@ -154,6 +154,18 @@ module Aws::FSx
154
154
  # * `RELEASE_NFS_V3_LOCKS` - Tracks the release of Network File System
155
155
  # (NFS) V3 locks on an Amazon FSx for OpenZFS file system.
156
156
  #
157
+ # * `VOLUME_INITIALIZE_WITH_SNAPSHOT` - A volume is being created from
158
+ # a snapshot on a different FSx for OpenZFS file system. You can
159
+ # initiate this from the Amazon FSx console, API (`CreateVolume`),
160
+ # or CLI (`create-volume`) when using the using the `FULL_COPY`
161
+ # strategy.
162
+ #
163
+ # * `VOLUME_UPDATE_WITH_SNAPSHOT` - A volume is being updated from a
164
+ # snapshot on a different FSx for OpenZFS file system. You can
165
+ # initiate this from the Amazon FSx console, API
166
+ # (`CopySnapshotAndUpdateVolume`), or CLI
167
+ # (`copy-snapshot-and-update-volume`).
168
+ #
157
169
  #
158
170
  #
159
171
  # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html
@@ -176,7 +188,7 @@ module Aws::FSx
176
188
  # @return [Time]
177
189
  #
178
190
  # @!attribute [rw] status
179
- # Describes the status of the administrative action, as follows:
191
+ # The status of the administrative action, as follows:
180
192
  #
181
193
  # * `FAILED` - Amazon FSx failed to process the administrative action
182
194
  # successfully.
@@ -196,9 +208,9 @@ module Aws::FSx
196
208
  # @return [String]
197
209
  #
198
210
  # @!attribute [rw] target_file_system_values
199
- # Describes the target value for the administration action, provided
200
- # in the `UpdateFileSystem` operation. Returned for
201
- # `FILE_SYSTEM_UPDATE` administrative actions.
211
+ # The target value for the administration action, provided in the
212
+ # `UpdateFileSystem` operation. Returned for `FILE_SYSTEM_UPDATE`
213
+ # administrative actions.
202
214
  # @return [Types::FileSystem]
203
215
  #
204
216
  # @!attribute [rw] failure_details
@@ -206,14 +218,23 @@ module Aws::FSx
206
218
  # @return [Types::AdministrativeActionFailureDetails]
207
219
  #
208
220
  # @!attribute [rw] target_volume_values
209
- # Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
210
- # volume.
221
+ # Describes an Amazon FSx volume.
211
222
  # @return [Types::Volume]
212
223
  #
213
224
  # @!attribute [rw] target_snapshot_values
214
225
  # A snapshot of an Amazon FSx for OpenZFS volume.
215
226
  # @return [Types::Snapshot]
216
227
  #
228
+ # @!attribute [rw] total_transfer_bytes
229
+ # The number of bytes that have transferred for the FSx for OpenZFS
230
+ # snapshot that you're copying.
231
+ # @return [Integer]
232
+ #
233
+ # @!attribute [rw] remaining_transfer_bytes
234
+ # The remaining bytes to transfer for the FSx for OpenZFS snapshot
235
+ # that you're copying.
236
+ # @return [Integer]
237
+ #
217
238
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AdministrativeAction AWS API Documentation
218
239
  #
219
240
  class AdministrativeAction < Struct.new(
@@ -224,7 +245,9 @@ module Aws::FSx
224
245
  :target_file_system_values,
225
246
  :failure_details,
226
247
  :target_volume_values,
227
- :target_snapshot_values)
248
+ :target_snapshot_values,
249
+ :total_transfer_bytes,
250
+ :remaining_transfer_bytes)
228
251
  SENSITIVE = []
229
252
  include Aws::Structure
230
253
  end
@@ -244,6 +267,43 @@ module Aws::FSx
244
267
  include Aws::Structure
245
268
  end
246
269
 
270
+ # Used to specify configuration options for a volume’s storage aggregate
271
+ # or aggregates.
272
+ #
273
+ # @!attribute [rw] aggregates
274
+ # The list of aggregates that this volume resides on. Aggregates are
275
+ # storage pools which make up your primary storage tier. Each
276
+ # high-availability (HA) pair has one aggregate. The names of the
277
+ # aggregates map to the names of the aggregates in the ONTAP CLI and
278
+ # REST API. For FlexVols, there will always be a single entry.
279
+ #
280
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
281
+ # the following conditions:
282
+ #
283
+ # * The strings in the value of `Aggregates` are not are not formatted
284
+ # as `aggrX`, where X is a number between 1 and 6.
285
+ #
286
+ # * The value of `Aggregates` contains aggregates that are not
287
+ # present.
288
+ #
289
+ # * One or more of the aggregates supplied are too close to the volume
290
+ # limit to support adding more volumes.
291
+ # @return [Array<String>]
292
+ #
293
+ # @!attribute [rw] total_constituents
294
+ # The total number of constituents this FlexGroup volume has. Not
295
+ # applicable for FlexVols.
296
+ # @return [Integer]
297
+ #
298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AggregateConfiguration AWS API Documentation
299
+ #
300
+ class AggregateConfiguration < Struct.new(
301
+ :aggregates,
302
+ :total_constituents)
303
+ SENSITIVE = []
304
+ include Aws::Structure
305
+ end
306
+
247
307
  # A DNS alias that is associated with the file system. You can use a DNS
248
308
  # alias to access a file system using user-defined DNS names, in
249
309
  # addition to the default DNS name that Amazon FSx assigns to the file
@@ -569,8 +629,7 @@ module Aws::FSx
569
629
  # @return [String]
570
630
  #
571
631
  # @!attribute [rw] volume
572
- # Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
573
- # volume.
632
+ # Describes an Amazon FSx volume.
574
633
  # @return [Types::Volume]
575
634
  #
576
635
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Backup AWS API Documentation
@@ -884,6 +943,128 @@ module Aws::FSx
884
943
  include Aws::Structure
885
944
  end
886
945
 
946
+ # @!attribute [rw] client_request_token
947
+ # (Optional) An idempotency token for resource creation, in a string
948
+ # of up to 63 ASCII characters. This token is automatically filled on
949
+ # your behalf when you use the Command Line Interface (CLI) or an
950
+ # Amazon Web Services SDK.
951
+ #
952
+ # **A suitable default value is auto-generated.** You should normally
953
+ # not need to pass this option.
954
+ # @return [String]
955
+ #
956
+ # @!attribute [rw] volume_id
957
+ # Specifies the ID of the volume that you are copying the snapshot to.
958
+ # @return [String]
959
+ #
960
+ # @!attribute [rw] source_snapshot_arn
961
+ # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
962
+ # identify Amazon Web Services resources. We require an ARN when you
963
+ # need to specify a resource unambiguously across all of Amazon Web
964
+ # Services. For more information, see [Amazon Resource Names
965
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
966
+ #
967
+ #
968
+ #
969
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
970
+ # @return [String]
971
+ #
972
+ # @!attribute [rw] copy_strategy
973
+ # Specifies the strategy to use when copying data from a snapshot to
974
+ # the volume.
975
+ #
976
+ # * `FULL_COPY` - Copies all data from the snapshot to the volume.
977
+ #
978
+ # * `INCREMENTAL_COPY` - Copies only the snapshot data that's changed
979
+ # since the previous replication.
980
+ #
981
+ # <note markdown="1"> `CLONE` isn't a valid copy strategy option for the
982
+ # `CopySnapshotAndUpdateVolume` operation.
983
+ #
984
+ # </note>
985
+ # @return [String]
986
+ #
987
+ # @!attribute [rw] options
988
+ # Confirms that you want to delete data on the destination volume that
989
+ # wasn’t there during the previous snapshot replication.
990
+ #
991
+ # Your replication will fail if you don’t include an option for a
992
+ # specific type of data and that data is on your destination. For
993
+ # example, if you don’t include `DELETE_INTERMEDIATE_SNAPSHOTS` and
994
+ # there are intermediate snapshots on the destination, you can’t copy
995
+ # the snapshot.
996
+ #
997
+ # * `DELETE_INTERMEDIATE_SNAPSHOTS` - Deletes snapshots on the
998
+ # destination volume that aren’t on the source volume.
999
+ #
1000
+ # * `DELETE_CLONED_VOLUMES` - Deletes snapshot clones on the
1001
+ # destination volume that aren't on the source volume.
1002
+ #
1003
+ # * `DELETE_INTERMEDIATE_DATA` - Overwrites snapshots on the
1004
+ # destination volume that don’t match the source snapshot that
1005
+ # you’re copying.
1006
+ # @return [Array<String>]
1007
+ #
1008
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopySnapshotAndUpdateVolumeRequest AWS API Documentation
1009
+ #
1010
+ class CopySnapshotAndUpdateVolumeRequest < Struct.new(
1011
+ :client_request_token,
1012
+ :volume_id,
1013
+ :source_snapshot_arn,
1014
+ :copy_strategy,
1015
+ :options)
1016
+ SENSITIVE = []
1017
+ include Aws::Structure
1018
+ end
1019
+
1020
+ # @!attribute [rw] volume_id
1021
+ # The ID of the volume that you copied the snapshot to.
1022
+ # @return [String]
1023
+ #
1024
+ # @!attribute [rw] lifecycle
1025
+ # The lifecycle state of the destination volume.
1026
+ # @return [String]
1027
+ #
1028
+ # @!attribute [rw] administrative_actions
1029
+ # A list of administrative actions for the file system that are in
1030
+ # process or waiting to be processed. Administrative actions describe
1031
+ # changes to the Amazon FSx system.
1032
+ # @return [Array<Types::AdministrativeAction>]
1033
+ #
1034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopySnapshotAndUpdateVolumeResponse AWS API Documentation
1035
+ #
1036
+ class CopySnapshotAndUpdateVolumeResponse < Struct.new(
1037
+ :volume_id,
1038
+ :lifecycle,
1039
+ :administrative_actions)
1040
+ SENSITIVE = []
1041
+ include Aws::Structure
1042
+ end
1043
+
1044
+ # Used to specify the configuration options for a volume's storage
1045
+ # aggregate or aggregates.
1046
+ #
1047
+ # @!attribute [rw] aggregates
1048
+ # Used to specify the names of aggregates on which the volume will be
1049
+ # created.
1050
+ # @return [Array<String>]
1051
+ #
1052
+ # @!attribute [rw] constituents_per_aggregate
1053
+ # Used to explicitly set the number of constituents within the
1054
+ # FlexGroup per storage aggregate. This field is optional when
1055
+ # creating a FlexGroup volume. If unspecified, the default value will
1056
+ # be 8. This field cannot be provided when creating a FlexVol volume.
1057
+ # @return [Integer]
1058
+ #
1059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateAggregateConfiguration AWS API Documentation
1060
+ #
1061
+ class CreateAggregateConfiguration < Struct.new(
1062
+ :aggregates,
1063
+ :constituents_per_aggregate)
1064
+ SENSITIVE = []
1065
+ include Aws::Structure
1066
+ end
1067
+
887
1068
  # The request object for the `CreateBackup` operation.
888
1069
  #
889
1070
  # @!attribute [rw] file_system_id
@@ -1462,7 +1643,8 @@ module Aws::FSx
1462
1643
  #
1463
1644
  # If used to create a file system other than OpenZFS, you must provide
1464
1645
  # a value that matches the backup's `StorageCapacity` value. If you
1465
- # provide any other value, Amazon FSx responds with a 400 Bad Request.
1646
+ # provide any other value, Amazon FSx responds with with an HTTP
1647
+ # status code 400 Bad Request.
1466
1648
  # @return [Integer]
1467
1649
  #
1468
1650
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupRequest AWS API Documentation
@@ -1801,6 +1983,9 @@ module Aws::FSx
1801
1983
  #
1802
1984
  # * `SINGLE_AZ_1` - A file system configured for Single-AZ redundancy.
1803
1985
  #
1986
+ # * `SINGLE_AZ_2` - A file system configured with multiple
1987
+ # high-availability (HA) pairs for Single-AZ redundancy.
1988
+ #
1804
1989
  # For information about the use cases for Multi-AZ and Single-AZ
1805
1990
  # deployments, refer to [Choosing a file system deployment type][1].
1806
1991
  #
@@ -1847,7 +2032,21 @@ module Aws::FSx
1847
2032
  #
1848
2033
  # @!attribute [rw] throughput_capacity
1849
2034
  # Sets the throughput capacity for the file system that you're
1850
- # creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.
2035
+ # creating in megabytes per second (MBps). For more information, see
2036
+ # [Managing throughput capacity][1] in the FSx for ONTAP User Guide.
2037
+ #
2038
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
2039
+ # the following conditions:
2040
+ #
2041
+ # * The value of `ThroughputCapacity` and
2042
+ # `ThroughputCapacityPerHAPair` are not the same value.
2043
+ #
2044
+ # * The value of `ThroughputCapacity` when divided by the value of
2045
+ # `HAPairs` is outside of the valid range for `ThroughputCapacity`.
2046
+ #
2047
+ #
2048
+ #
2049
+ # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html
1851
2050
  # @return [Integer]
1852
2051
  #
1853
2052
  # @!attribute [rw] weekly_maintenance_start_time
@@ -1867,6 +2066,50 @@ module Aws::FSx
1867
2066
  # [1]: https://en.wikipedia.org/wiki/ISO_week_date
1868
2067
  # @return [String]
1869
2068
  #
2069
+ # @!attribute [rw] ha_pairs
2070
+ # Specifies how many high-availability (HA) pairs the file system will
2071
+ # have. The default value is 1. The value of this property affects the
2072
+ # values of `StorageCapacity`, `Iops`, and `ThroughputCapacity`. For
2073
+ # more information, see [High-availability (HA) pairs][1] in the FSx
2074
+ # for ONTAP user guide.
2075
+ #
2076
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
2077
+ # the following conditions:
2078
+ #
2079
+ # * The value of `HAPairs` is less than 1 or greater than 6.
2080
+ #
2081
+ # * The value of `HAPairs` is greater than 1 and the value of
2082
+ # `DeploymentType` is `SINGLE_AZ_1` or `MULTI_AZ_1`.
2083
+ #
2084
+ #
2085
+ #
2086
+ # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html
2087
+ # @return [Integer]
2088
+ #
2089
+ # @!attribute [rw] throughput_capacity_per_ha_pair
2090
+ # Use to choose the throughput capacity per HA pair, rather than the
2091
+ # total throughput for the file system.
2092
+ #
2093
+ # This field and `ThroughputCapacity` cannot be defined in the same
2094
+ # API call, but one is required.
2095
+ #
2096
+ # This field and `ThroughputCapacity` are the same for file systems
2097
+ # with one HA pair.
2098
+ #
2099
+ # * For `SINGLE_AZ_1` and `MULTI_AZ_1`, valid values are 128, 256,
2100
+ # 512, 1024, 2048, or 4096 MBps.
2101
+ #
2102
+ # * For `SINGLE_AZ_2`, valid values are 3072 or 6144 MBps.
2103
+ #
2104
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
2105
+ # the following conditions:
2106
+ #
2107
+ # * The value of `ThroughputCapacity` and
2108
+ # `ThroughputCapacityPerHAPair` are not the same value
2109
+ #
2110
+ # * The value of `ThroughputCapacityPerHAPair` is not a valid value.
2111
+ # @return [Integer]
2112
+ #
1870
2113
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemOntapConfiguration AWS API Documentation
1871
2114
  #
1872
2115
  class CreateFileSystemOntapConfiguration < Struct.new(
@@ -1879,7 +2122,9 @@ module Aws::FSx
1879
2122
  :preferred_subnet_id,
1880
2123
  :route_table_ids,
1881
2124
  :throughput_capacity,
1882
- :weekly_maintenance_start_time)
2125
+ :weekly_maintenance_start_time,
2126
+ :ha_pairs,
2127
+ :throughput_capacity_per_ha_pair)
1883
2128
  SENSITIVE = [:fsx_admin_password]
1884
2129
  include Aws::Structure
1885
2130
  end
@@ -2079,7 +2324,9 @@ module Aws::FSx
2079
2324
  # GiB, and increments of 3600 GiB.
2080
2325
  #
2081
2326
  # **FSx for ONTAP file systems** - The amount of storage capacity that
2082
- # you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
2327
+ # you can configure depends on the value of the `HAPairs` property.
2328
+ # The minimum value is calculated as 1,024 * `HAPairs` and the maxium
2329
+ # is calculated as 524,288 * `HAPairs`..
2083
2330
  #
2084
2331
  # **FSx for OpenZFS file systems** - The amount of storage capacity
2085
2332
  # that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).
@@ -2564,6 +2811,25 @@ module Aws::FSx
2564
2811
  # Specifies the SnapLock configuration for an FSx for ONTAP volume.
2565
2812
  # @return [Types::CreateSnaplockConfiguration]
2566
2813
  #
2814
+ # @!attribute [rw] volume_style
2815
+ # Use to specify the style of an ONTAP volume. For more information
2816
+ # about FlexVols and FlexGroups, see [Volume types][1] in Amazon FSx
2817
+ # for NetApp ONTAP User Guide.
2818
+ #
2819
+ #
2820
+ #
2821
+ # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types.html
2822
+ # @return [String]
2823
+ #
2824
+ # @!attribute [rw] aggregate_configuration
2825
+ # Use to specify configuration options for a volume’s storage
2826
+ # aggregate or aggregates.
2827
+ # @return [Types::CreateAggregateConfiguration]
2828
+ #
2829
+ # @!attribute [rw] size_in_bytes
2830
+ # The configured size of the volume, in bytes.
2831
+ # @return [Integer]
2832
+ #
2567
2833
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOntapVolumeConfiguration AWS API Documentation
2568
2834
  #
2569
2835
  class CreateOntapVolumeConfiguration < Struct.new(
@@ -2576,13 +2842,16 @@ module Aws::FSx
2576
2842
  :ontap_volume_type,
2577
2843
  :snapshot_policy,
2578
2844
  :copy_tags_to_backups,
2579
- :snaplock_configuration)
2845
+ :snaplock_configuration,
2846
+ :volume_style,
2847
+ :aggregate_configuration,
2848
+ :size_in_bytes)
2580
2849
  SENSITIVE = []
2581
2850
  include Aws::Structure
2582
2851
  end
2583
2852
 
2584
- # The snapshot configuration to use when creating an OpenZFS volume from
2585
- # a snapshot.
2853
+ # The snapshot configuration to use when creating an Amazon FSx for
2854
+ # OpenZFS volume from a snapshot.
2586
2855
  #
2587
2856
  # @!attribute [rw] snapshot_arn
2588
2857
  # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
@@ -2597,8 +2866,8 @@ module Aws::FSx
2597
2866
  # @return [String]
2598
2867
  #
2599
2868
  # @!attribute [rw] copy_strategy
2600
- # The strategy used when copying data from the snapshot to the new
2601
- # volume.
2869
+ # Specifies the strategy used when copying data from the snapshot to
2870
+ # the new volume.
2602
2871
  #
2603
2872
  # * `CLONE` - The new volume references the data in the origin
2604
2873
  # snapshot. Cloning a snapshot is faster than copying data from the
@@ -2607,6 +2876,19 @@ module Aws::FSx
2607
2876
  # volume using its copied data.
2608
2877
  #
2609
2878
  # * `FULL_COPY` - Copies all data from the snapshot to the new volume.
2879
+ #
2880
+ # Specify this option to create the volume from a snapshot on
2881
+ # another FSx for OpenZFS file system.
2882
+ #
2883
+ # <note markdown="1"> The `INCREMENTAL_COPY` option is only for updating an existing
2884
+ # volume by using a snapshot from another FSx for OpenZFS file system.
2885
+ # For more information, see [CopySnapshotAndUpdateVolume][1].
2886
+ #
2887
+ # </note>
2888
+ #
2889
+ #
2890
+ #
2891
+ # [1]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html
2610
2892
  # @return [String]
2611
2893
  #
2612
2894
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOpenZFSOriginSnapshotConfiguration AWS API Documentation
@@ -4680,6 +4962,25 @@ module Aws::FSx
4680
4962
  include Aws::Structure
4681
4963
  end
4682
4964
 
4965
+ # @api private
4966
+ #
4967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeSharedVpcConfigurationRequest AWS API Documentation
4968
+ #
4969
+ class DescribeSharedVpcConfigurationRequest < Aws::EmptyStructure; end
4970
+
4971
+ # @!attribute [rw] enable_fsx_route_table_updates_from_participant_accounts
4972
+ # Indicates whether participant accounts can create FSx for ONTAP
4973
+ # Multi-AZ file systems in shared subnets.
4974
+ # @return [String]
4975
+ #
4976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeSharedVpcConfigurationResponse AWS API Documentation
4977
+ #
4978
+ class DescribeSharedVpcConfigurationResponse < Struct.new(
4979
+ :enable_fsx_route_table_updates_from_participant_accounts)
4980
+ SENSITIVE = []
4981
+ include Aws::Structure
4982
+ end
4983
+
4683
4984
  # @!attribute [rw] snapshot_ids
4684
4985
  # The IDs of the snapshots that you want to retrieve. This parameter
4685
4986
  # value overrides any filters. If any IDs aren't found, a
@@ -4906,6 +5207,15 @@ module Aws::FSx
4906
5207
  #
4907
5208
  # @!attribute [rw] iops
4908
5209
  # The total number of SSD IOPS provisioned for the file system.
5210
+ #
5211
+ # The minimum and maximum values for this property depend on the value
5212
+ # of `HAPairs` and `StorageCapacity`. The minimum value is calculated
5213
+ # as `StorageCapacity` * 3 * `HAPairs` (3 IOPS per GB of
5214
+ # `StorageCapacity`). The maximum value is calculated as 200,000 *
5215
+ # `HAPairs`.
5216
+ #
5217
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) if
5218
+ # the value of `Iops` is outside of the minimum or maximum values.
4909
5219
  # @return [Integer]
4910
5220
  #
4911
5221
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DiskIopsConfiguration AWS API Documentation
@@ -5487,6 +5797,10 @@ module Aws::FSx
5487
5797
  #
5488
5798
  # @!attribute [rw] storage_capacity
5489
5799
  # The storage capacity of the file system in gibibytes (GiB).
5800
+ #
5801
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) if
5802
+ # the value of `StorageCapacity` is outside of the minimum or maximum
5803
+ # values.
5490
5804
  # @return [Integer]
5491
5805
  #
5492
5806
  # @!attribute [rw] storage_type
@@ -6378,6 +6692,9 @@ module Aws::FSx
6378
6692
  #
6379
6693
  # * `SINGLE_AZ_1` - A file system configured for Single-AZ redundancy.
6380
6694
  #
6695
+ # * `SINGLE_AZ_2` - A file system configured with multiple
6696
+ # high-availability (HA) pairs for Single-AZ redundancy.
6697
+ #
6381
6698
  # For information about the use cases for Multi-AZ and Single-AZ
6382
6699
  # deployments, refer to [Choosing Multi-AZ or Single-AZ file system
6383
6700
  # deployment][1].
@@ -6452,6 +6769,55 @@ module Aws::FSx
6452
6769
  # response.
6453
6770
  # @return [String]
6454
6771
  #
6772
+ # @!attribute [rw] ha_pairs
6773
+ # Specifies how many high-availability (HA) file server pairs the file
6774
+ # system will have. The default value is 1. The value of this property
6775
+ # affects the values of `StorageCapacity`, `Iops`, and
6776
+ # `ThroughputCapacity`. For more information, see [High-availability
6777
+ # (HA) pairs][1] in the FSx for ONTAP user guide.
6778
+ #
6779
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
6780
+ # the following conditions:
6781
+ #
6782
+ # * The value of `HAPairs` is less than 1 or greater than 6.
6783
+ #
6784
+ # * The value of `HAPairs` is greater than 1 and the value of
6785
+ # `DeploymentType` is `SINGLE_AZ_1` or `MULTI_AZ_1`.
6786
+ #
6787
+ #
6788
+ #
6789
+ # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html
6790
+ # @return [Integer]
6791
+ #
6792
+ # @!attribute [rw] throughput_capacity_per_ha_pair
6793
+ # Use to choose the throughput capacity per HA pair. When the value of
6794
+ # `HAPairs` is equal to 1, the value of `ThroughputCapacityPerHAPair`
6795
+ # is the total throughput for the file system.
6796
+ #
6797
+ # This field and `ThroughputCapacity` cannot be defined in the same
6798
+ # API call, but one is required.
6799
+ #
6800
+ # This field and `ThroughputCapacity` are the same for file systems
6801
+ # with one HA pair.
6802
+ #
6803
+ # * For `SINGLE_AZ_1` and `MULTI_AZ_1`, valid values are 128, 256,
6804
+ # 512, 1024, 2048, or 4096 MBps.
6805
+ #
6806
+ # * For `SINGLE_AZ_2`, valid values are 3072 or 6144 MBps.
6807
+ #
6808
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
6809
+ # the following conditions:
6810
+ #
6811
+ # * The value of `ThroughputCapacity` and
6812
+ # `ThroughputCapacityPerHAPair` are not the same value.
6813
+ #
6814
+ # * The value of deployment type is `SINGLE_AZ_2` and
6815
+ # `ThroughputCapacity` / `ThroughputCapacityPerHAPair` is a valid HA
6816
+ # pair (a value between 2 and 6).
6817
+ #
6818
+ # * The value of `ThroughputCapacityPerHAPair` is not a valid value.
6819
+ # @return [Integer]
6820
+ #
6455
6821
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapFileSystemConfiguration AWS API Documentation
6456
6822
  #
6457
6823
  class OntapFileSystemConfiguration < Struct.new(
@@ -6465,7 +6831,9 @@ module Aws::FSx
6465
6831
  :route_table_ids,
6466
6832
  :throughput_capacity,
6467
6833
  :weekly_maintenance_start_time,
6468
- :fsx_admin_password)
6834
+ :fsx_admin_password,
6835
+ :ha_pairs,
6836
+ :throughput_capacity_per_ha_pair)
6469
6837
  SENSITIVE = [:fsx_admin_password]
6470
6838
  include Aws::Structure
6471
6839
  end
@@ -6567,8 +6935,8 @@ module Aws::FSx
6567
6935
  # You can also provide the name of a custom policy that you created
6568
6936
  # with the ONTAP CLI or REST API.
6569
6937
  #
6570
- # For more information, see [Snapshot policies][1] in the *Amazon FSx
6571
- # for NetApp ONTAP User Guide*.
6938
+ # For more information, see [Snapshot policies][1] in the Amazon FSx
6939
+ # for NetApp ONTAP User Guide.
6572
6940
  #
6573
6941
  #
6574
6942
  #
@@ -6591,6 +6959,25 @@ module Aws::FSx
6591
6959
  # volume.
6592
6960
  # @return [Types::SnaplockConfiguration]
6593
6961
  #
6962
+ # @!attribute [rw] volume_style
6963
+ # Use to specify the style of an ONTAP volume. For more information
6964
+ # about FlexVols and FlexGroups, see [Volume types][1] in Amazon FSx
6965
+ # for NetApp ONTAP User Guide.
6966
+ #
6967
+ #
6968
+ #
6969
+ # [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/volume-types.html
6970
+ # @return [String]
6971
+ #
6972
+ # @!attribute [rw] aggregate_configuration
6973
+ # This structure specifies configuration options for a volume’s
6974
+ # storage aggregate or aggregates.
6975
+ # @return [Types::AggregateConfiguration]
6976
+ #
6977
+ # @!attribute [rw] size_in_bytes
6978
+ # The configured size of the volume, in bytes.
6979
+ # @return [Integer]
6980
+ #
6594
6981
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapVolumeConfiguration AWS API Documentation
6595
6982
  #
6596
6983
  class OntapVolumeConfiguration < Struct.new(
@@ -6606,7 +6993,10 @@ module Aws::FSx
6606
6993
  :ontap_volume_type,
6607
6994
  :snapshot_policy,
6608
6995
  :copy_tags_to_backups,
6609
- :snaplock_configuration)
6996
+ :snaplock_configuration,
6997
+ :volume_style,
6998
+ :aggregate_configuration,
6999
+ :size_in_bytes)
6610
7000
  SENSITIVE = []
6611
7001
  include Aws::Structure
6612
7002
  end
@@ -6860,8 +7250,8 @@ module Aws::FSx
6860
7250
  include Aws::Structure
6861
7251
  end
6862
7252
 
6863
- # The snapshot configuration to use when creating an OpenZFS volume from
6864
- # a snapshot.
7253
+ # The snapshot configuration used when creating an Amazon FSx for
7254
+ # OpenZFS volume from a snapshot.
6865
7255
  #
6866
7256
  # @!attribute [rw] snapshot_arn
6867
7257
  # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
@@ -6886,6 +7276,16 @@ module Aws::FSx
6886
7276
  # volume using its copied data.
6887
7277
  #
6888
7278
  # * `FULL_COPY` - Copies all data from the snapshot to the new volume.
7279
+ #
7280
+ # <note markdown="1"> The `INCREMENTAL_COPY` option is only for updating an existing
7281
+ # volume by using a snapshot from another FSx for OpenZFS file system.
7282
+ # For more information, see [CopySnapshotAndUpdateVolume][1].
7283
+ #
7284
+ # </note>
7285
+ #
7286
+ #
7287
+ #
7288
+ # [1]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_CopySnapshotAndUpdateVolume.html
6889
7289
  # @return [String]
6890
7290
  #
6891
7291
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSOriginSnapshotConfiguration AWS API Documentation
@@ -7016,6 +7416,29 @@ module Aws::FSx
7016
7416
  # restored from snapshot.
7017
7417
  # @return [Boolean]
7018
7418
  #
7419
+ # @!attribute [rw] delete_intermediate_data
7420
+ # A Boolean value indicating whether snapshot data that differs
7421
+ # between the current state and the specified snapshot should be
7422
+ # overwritten when a volume is restored from a snapshot.
7423
+ # @return [Boolean]
7424
+ #
7425
+ # @!attribute [rw] source_snapshot_arn
7426
+ # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
7427
+ # identify Amazon Web Services resources. We require an ARN when you
7428
+ # need to specify a resource unambiguously across all of Amazon Web
7429
+ # Services. For more information, see [Amazon Resource Names
7430
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
7431
+ #
7432
+ #
7433
+ #
7434
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
7435
+ # @return [String]
7436
+ #
7437
+ # @!attribute [rw] destination_snapshot
7438
+ # The ID of the snapshot that's being copied or was most recently
7439
+ # copied to the destination volume.
7440
+ # @return [String]
7441
+ #
7019
7442
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSVolumeConfiguration AWS API Documentation
7020
7443
  #
7021
7444
  class OpenZFSVolumeConfiguration < Struct.new(
@@ -7032,7 +7455,10 @@ module Aws::FSx
7032
7455
  :user_and_group_quotas,
7033
7456
  :restore_to_snapshot,
7034
7457
  :delete_intermediate_snaphots,
7035
- :delete_cloned_volumes)
7458
+ :delete_cloned_volumes,
7459
+ :delete_intermediate_data,
7460
+ :source_snapshot_arn,
7461
+ :destination_snapshot)
7036
7462
  SENSITIVE = []
7037
7463
  include Aws::Structure
7038
7464
  end
@@ -8460,10 +8886,18 @@ module Aws::FSx
8460
8886
  #
8461
8887
  # @!attribute [rw] throughput_capacity
8462
8888
  # Enter a new value to change the amount of throughput capacity for
8463
- # the file system. Throughput capacity is measured in megabytes per
8464
- # second (MBps). Valid values are 128, 256, 512, 1024, 2048, and 4096
8465
- # MBps. For more information, see [Managing throughput capacity][1] in
8466
- # the FSx for ONTAP User Guide.
8889
+ # the file system in megabytes per second (MBps). For more
8890
+ # information, see [Managing throughput capacity][1] in the FSx for
8891
+ # ONTAP User Guide.
8892
+ #
8893
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
8894
+ # the following conditions:
8895
+ #
8896
+ # * The value of `ThroughputCapacity` and
8897
+ # `ThroughputCapacityPerHAPair` are not the same value.
8898
+ #
8899
+ # * The value of `ThroughputCapacity` when divided by the value of
8900
+ # `HAPairs` is outside of the valid range for `ThroughputCapacity`.
8467
8901
  #
8468
8902
  #
8469
8903
  #
@@ -8483,6 +8917,30 @@ module Aws::FSx
8483
8917
  # the list of VPC route table IDs for a file system.
8484
8918
  # @return [Array<String>]
8485
8919
  #
8920
+ # @!attribute [rw] throughput_capacity_per_ha_pair
8921
+ # Use to choose the throughput capacity per HA pair, rather than the
8922
+ # total throughput for the file system.
8923
+ #
8924
+ # This field and `ThroughputCapacity` cannot be defined in the same
8925
+ # API call, but one is required.
8926
+ #
8927
+ # This field and `ThroughputCapacity` are the same for file systems
8928
+ # with one HA pair.
8929
+ #
8930
+ # * For `SINGLE_AZ_1` and `MULTI_AZ_1`, valid values are 128, 256,
8931
+ # 512, 1024, 2048, or 4096 MBps.
8932
+ #
8933
+ # * For `SINGLE_AZ_2`, valid values are 3072 or 6144 MBps.
8934
+ #
8935
+ # Amazon FSx responds with an HTTP status code 400 (Bad Request) for
8936
+ # the following conditions:
8937
+ #
8938
+ # The value of `ThroughputCapacity` and `ThroughputCapacityPerHAPair`
8939
+ # are not the same value.
8940
+ #
8941
+ # The value of `ThroughputCapacityPerHAPair` is not a valid value.
8942
+ # @return [Integer]
8943
+ #
8486
8944
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemOntapConfiguration AWS API Documentation
8487
8945
  #
8488
8946
  class UpdateFileSystemOntapConfiguration < Struct.new(
@@ -8493,7 +8951,8 @@ module Aws::FSx
8493
8951
  :disk_iops_configuration,
8494
8952
  :throughput_capacity,
8495
8953
  :add_route_table_ids,
8496
- :remove_route_table_ids)
8954
+ :remove_route_table_ids,
8955
+ :throughput_capacity_per_ha_pair)
8497
8956
  SENSITIVE = [:fsx_admin_password]
8498
8957
  include Aws::Structure
8499
8958
  end
@@ -8870,6 +9329,10 @@ module Aws::FSx
8870
9329
  # an FSx for ONTAP SnapLock volume.
8871
9330
  # @return [Types::UpdateSnaplockConfiguration]
8872
9331
  #
9332
+ # @!attribute [rw] size_in_bytes
9333
+ # The configured size of the volume, in bytes.
9334
+ # @return [Integer]
9335
+ #
8873
9336
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateOntapVolumeConfiguration AWS API Documentation
8874
9337
  #
8875
9338
  class UpdateOntapVolumeConfiguration < Struct.new(
@@ -8880,7 +9343,8 @@ module Aws::FSx
8880
9343
  :tiering_policy,
8881
9344
  :snapshot_policy,
8882
9345
  :copy_tags_to_backups,
8883
- :snaplock_configuration)
9346
+ :snaplock_configuration,
9347
+ :size_in_bytes)
8884
9348
  SENSITIVE = []
8885
9349
  include Aws::Structure
8886
9350
  end
@@ -8962,6 +9426,44 @@ module Aws::FSx
8962
9426
  include Aws::Structure
8963
9427
  end
8964
9428
 
9429
+ # @!attribute [rw] enable_fsx_route_table_updates_from_participant_accounts
9430
+ # Specifies whether participant accounts can create FSx for ONTAP
9431
+ # Multi-AZ file systems in shared subnets. Set to `true` to enable or
9432
+ # `false` to disable.
9433
+ # @return [String]
9434
+ #
9435
+ # @!attribute [rw] client_request_token
9436
+ # (Optional) An idempotency token for resource creation, in a string
9437
+ # of up to 63 ASCII characters. This token is automatically filled on
9438
+ # your behalf when you use the Command Line Interface (CLI) or an
9439
+ # Amazon Web Services SDK.
9440
+ #
9441
+ # **A suitable default value is auto-generated.** You should normally
9442
+ # not need to pass this option.
9443
+ # @return [String]
9444
+ #
9445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSharedVpcConfigurationRequest AWS API Documentation
9446
+ #
9447
+ class UpdateSharedVpcConfigurationRequest < Struct.new(
9448
+ :enable_fsx_route_table_updates_from_participant_accounts,
9449
+ :client_request_token)
9450
+ SENSITIVE = []
9451
+ include Aws::Structure
9452
+ end
9453
+
9454
+ # @!attribute [rw] enable_fsx_route_table_updates_from_participant_accounts
9455
+ # Indicates whether participant accounts can create FSx for ONTAP
9456
+ # Multi-AZ file systems in shared subnets.
9457
+ # @return [String]
9458
+ #
9459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSharedVpcConfigurationResponse AWS API Documentation
9460
+ #
9461
+ class UpdateSharedVpcConfigurationResponse < Struct.new(
9462
+ :enable_fsx_route_table_updates_from_participant_accounts)
9463
+ SENSITIVE = []
9464
+ include Aws::Structure
9465
+ end
9466
+
8965
9467
  # Updates the SnapLock configuration for an existing FSx for ONTAP
8966
9468
  # volume.
8967
9469
  #
@@ -9198,8 +9700,7 @@ module Aws::FSx
9198
9700
  include Aws::Structure
9199
9701
  end
9200
9702
 
9201
- # Describes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS
9202
- # volume.
9703
+ # Describes an Amazon FSx volume.
9203
9704
  #
9204
9705
  # @!attribute [rw] creation_time
9205
9706
  # The time that the resource was created, in seconds (since