aws-sdk-fsx 1.50.0 → 1.53.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.
@@ -796,15 +796,24 @@ module Aws::FSx
796
796
  # @return [String]
797
797
  #
798
798
  # @!attribute [rw] kms_key_id
799
- # The ID of the Key Management Service (KMS) key used to encrypt the
800
- # file system's data for Amazon FSx for Windows File Server file
801
- # systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
802
- # for Lustre `PERSISTENT_1` and `PERSISTENT_2` file systems at rest.
803
- # If this ID isn't specified, the key managed by Amazon FSx is used.
804
- # The Amazon FSx for Lustre `SCRATCH_1` and `SCRATCH_2` file systems
805
- # are always encrypted at rest using Amazon FSx-managed keys. For more
806
- # information, see [Encrypt][1] in the *Key Management Service API
807
- # Reference*.
799
+ # Specifies the ID of the Key Management Service (KMS) key to use for
800
+ # encrypting data on Amazon FSx file systems, as follows:
801
+ #
802
+ # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment
803
+ # types only.
804
+ #
805
+ # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon
806
+ # FSx service KMS key for your account.
807
+ #
808
+ # * Amazon FSx for NetApp ONTAP
809
+ #
810
+ # * Amazon FSx for OpenZFS
811
+ #
812
+ # * Amazon FSx for Windows File Server
813
+ #
814
+ # If a `KmsKeyId` isn't specified, the Amazon FSx-managed KMS key for
815
+ # your account is used. For more information, see [Encrypt][1] in the
816
+ # *Key Management Service API Reference*.
808
817
  #
809
818
  #
810
819
  #
@@ -966,6 +975,13 @@ module Aws::FSx
966
975
  # from or imported to. This file system directory can be linked to
967
976
  # only one Amazon S3 bucket, and no other S3 bucket can be linked to
968
977
  # the directory.
978
+ #
979
+ # <note markdown="1"> If you specify only a forward slash (`/`) as the file system path,
980
+ # you can link only 1 data repository to the file system. You can only
981
+ # specify "/" as the file system path for the first data repository
982
+ # associated with a file system.
983
+ #
984
+ # </note>
969
985
  # @return [String]
970
986
  #
971
987
  # @!attribute [rw] data_repository_path
@@ -1209,7 +1225,8 @@ module Aws::FSx
1209
1225
  # iops: 1,
1210
1226
  # },
1211
1227
  # root_volume_configuration: {
1212
- # data_compression_type: "NONE", # accepts NONE, ZSTD
1228
+ # record_size_ki_b: 1,
1229
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
1213
1230
  # nfs_exports: [
1214
1231
  # {
1215
1232
  # client_configurations: [ # required
@@ -1322,15 +1339,24 @@ module Aws::FSx
1322
1339
  # @return [String]
1323
1340
  #
1324
1341
  # @!attribute [rw] kms_key_id
1325
- # The ID of the Key Management Service (KMS) key used to encrypt the
1326
- # file system's data for Amazon FSx for Windows File Server file
1327
- # systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
1328
- # for Lustre `PERSISTENT_1` and `PERSISTENT_2` file systems at rest.
1329
- # If this ID isn't specified, the key managed by Amazon FSx is used.
1330
- # The Amazon FSx for Lustre `SCRATCH_1` and `SCRATCH_2` file systems
1331
- # are always encrypted at rest using Amazon FSx-managed keys. For more
1332
- # information, see [Encrypt][1] in the *Key Management Service API
1333
- # Reference*.
1342
+ # Specifies the ID of the Key Management Service (KMS) key to use for
1343
+ # encrypting data on Amazon FSx file systems, as follows:
1344
+ #
1345
+ # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment
1346
+ # types only.
1347
+ #
1348
+ # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon
1349
+ # FSx service KMS key for your account.
1350
+ #
1351
+ # * Amazon FSx for NetApp ONTAP
1352
+ #
1353
+ # * Amazon FSx for OpenZFS
1354
+ #
1355
+ # * Amazon FSx for Windows File Server
1356
+ #
1357
+ # If a `KmsKeyId` isn't specified, the Amazon FSx-managed KMS key for
1358
+ # your account is used. For more information, see [Encrypt][1] in the
1359
+ # *Key Management Service API Reference*.
1334
1360
  #
1335
1361
  #
1336
1362
  #
@@ -1570,14 +1596,14 @@ module Aws::FSx
1570
1596
  #
1571
1597
  # <note markdown="1"> This parameter is not supported for file systems with the
1572
1598
  # `Persistent_2` deployment type. Instead, use
1573
- # `CreateDataRepositoryAssociation"` to create a data repository
1599
+ # `CreateDataRepositoryAssociation` to create a data repository
1574
1600
  # association to link your Lustre file system to a data repository.
1575
1601
  #
1576
1602
  # </note>
1577
1603
  #
1578
1604
  #
1579
1605
  #
1580
- # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html
1606
+ # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/older-deployment-types.html#legacy-auto-import-from-s3
1581
1607
  # @return [String]
1582
1608
  #
1583
1609
  # @!attribute [rw] per_unit_storage_throughput
@@ -1731,6 +1757,10 @@ module Aws::FSx
1731
1757
  # Specifies the IP address range in which the endpoints to access your
1732
1758
  # file system will be created. By default, Amazon FSx selects an
1733
1759
  # unused IP address range for you from the 198.19.* range.
1760
+ #
1761
+ # The Endpoint IP address range you select for your file system must
1762
+ # exist outside the VPC's CIDR range and must be at least /30 or
1763
+ # larger.
1734
1764
  # @return [String]
1735
1765
  #
1736
1766
  # @!attribute [rw] fsx_admin_password
@@ -1796,8 +1826,8 @@ module Aws::FSx
1796
1826
  include Aws::Structure
1797
1827
  end
1798
1828
 
1799
- # The OpenZFS configuration properties for the file system that you are
1800
- # creating.
1829
+ # The Amazon FSx for OpenZFS configuration properties for the file
1830
+ # system that you are creating.
1801
1831
  #
1802
1832
  # @note When making an API call, you may pass CreateFileSystemOpenZFSConfiguration
1803
1833
  # data as a hash:
@@ -1815,7 +1845,8 @@ module Aws::FSx
1815
1845
  # iops: 1,
1816
1846
  # },
1817
1847
  # root_volume_configuration: {
1818
- # data_compression_type: "NONE", # accepts NONE, ZSTD
1848
+ # record_size_ki_b: 1,
1849
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
1819
1850
  # nfs_exports: [
1820
1851
  # {
1821
1852
  # client_configurations: [ # required
@@ -1873,8 +1904,8 @@ module Aws::FSx
1873
1904
  #
1874
1905
  # @!attribute [rw] deployment_type
1875
1906
  # Specifies the file system deployment type. Amazon FSx for OpenZFS
1876
- # supports `SINGLE_AZ_1`. `SINGLE_AZ_1` is a file system configured
1877
- # for a single Availability Zone (AZ) of redundancy.
1907
+ # supports `SINGLE_AZ_1`. `SINGLE_AZ_1` deployment type is configured
1908
+ # for redundancy within a single Availability Zone.
1878
1909
  # @return [String]
1879
1910
  #
1880
1911
  # @!attribute [rw] throughput_capacity
@@ -2022,7 +2053,8 @@ module Aws::FSx
2022
2053
  # iops: 1,
2023
2054
  # },
2024
2055
  # root_volume_configuration: {
2025
- # data_compression_type: "NONE", # accepts NONE, ZSTD
2056
+ # record_size_ki_b: 1,
2057
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
2026
2058
  # nfs_exports: [
2027
2059
  # {
2028
2060
  # client_configurations: [ # required
@@ -2152,15 +2184,24 @@ module Aws::FSx
2152
2184
  # @return [Array<Types::Tag>]
2153
2185
  #
2154
2186
  # @!attribute [rw] kms_key_id
2155
- # The ID of the Key Management Service (KMS) key used to encrypt the
2156
- # file system's data for Amazon FSx for Windows File Server file
2157
- # systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
2158
- # for Lustre `PERSISTENT_1` and `PERSISTENT_2` file systems at rest.
2159
- # If this ID isn't specified, the key managed by Amazon FSx is used.
2160
- # The Amazon FSx for Lustre `SCRATCH_1` and `SCRATCH_2` file systems
2161
- # are always encrypted at rest using Amazon FSx-managed keys. For more
2162
- # information, see [Encrypt][1] in the *Key Management Service API
2163
- # Reference*.
2187
+ # Specifies the ID of the Key Management Service (KMS) key to use for
2188
+ # encrypting data on Amazon FSx file systems, as follows:
2189
+ #
2190
+ # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment
2191
+ # types only.
2192
+ #
2193
+ # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon
2194
+ # FSx service KMS key for your account.
2195
+ #
2196
+ # * Amazon FSx for NetApp ONTAP
2197
+ #
2198
+ # * Amazon FSx for OpenZFS
2199
+ #
2200
+ # * Amazon FSx for Windows File Server
2201
+ #
2202
+ # If a `KmsKeyId` isn't specified, the Amazon FSx-managed KMS key for
2203
+ # your account is used. For more information, see [Encrypt][1] in the
2204
+ # *Key Management Service API Reference*.
2164
2205
  #
2165
2206
  #
2166
2207
  #
@@ -2583,8 +2624,8 @@ module Aws::FSx
2583
2624
  include Aws::Structure
2584
2625
  end
2585
2626
 
2586
- # Specifies the configuration of the OpenZFS volume that you are
2587
- # creating.
2627
+ # Specifies the configuration of the Amazon FSx for OpenZFS volume that
2628
+ # you are creating.
2588
2629
  #
2589
2630
  # @note When making an API call, you may pass CreateOpenZFSVolumeConfiguration
2590
2631
  # data as a hash:
@@ -2593,7 +2634,8 @@ module Aws::FSx
2593
2634
  # parent_volume_id: "VolumeId", # required
2594
2635
  # storage_capacity_reservation_gi_b: 1,
2595
2636
  # storage_capacity_quota_gi_b: 1,
2596
- # data_compression_type: "NONE", # accepts NONE, ZSTD
2637
+ # record_size_ki_b: 1,
2638
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
2597
2639
  # copy_tags_to_snapshots: false,
2598
2640
  # origin_snapshot: {
2599
2641
  # snapshot_arn: "ResourceARN", # required
@@ -2620,32 +2662,83 @@ module Aws::FSx
2620
2662
  # }
2621
2663
  #
2622
2664
  # @!attribute [rw] parent_volume_id
2623
- # The ID of the volume to use as the parent volume.
2665
+ # The ID of the volume to use as the parent volume of the volume that
2666
+ # you are creating.
2624
2667
  # @return [String]
2625
2668
  #
2626
2669
  # @!attribute [rw] storage_capacity_reservation_gi_b
2627
- # The amount of storage in gibibytes (GiB) to reserve from the parent
2628
- # volume. You can't reserve more storage than the parent volume has
2629
- # reserved.
2670
+ # Specifies the amount of storage in gibibytes (GiB) to reserve from
2671
+ # the parent volume. Setting `StorageCapacityReservationGiB`
2672
+ # guarantees that the specified amount of storage space on the parent
2673
+ # volume will always be available for the volume. You can't reserve
2674
+ # more storage than the parent volume has. To *not* specify a storage
2675
+ # capacity reservation, set this to `0` or `-1`. For more information,
2676
+ # see [Volume properties][1] in the *Amazon FSx for OpenZFS User
2677
+ # Guide*.
2678
+ #
2679
+ #
2680
+ #
2681
+ # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties
2630
2682
  # @return [Integer]
2631
2683
  #
2632
2684
  # @!attribute [rw] storage_capacity_quota_gi_b
2633
- # The maximum amount of storage in gibibytes (GiB) that the volume can
2634
- # use from its parent. You can specify a quota larger than the storage
2635
- # on the parent volume.
2685
+ # Sets the maximum storage size in gibibytes (GiB) for the volume. You
2686
+ # can specify a quota that is larger than the storage on the parent
2687
+ # volume. A volume quota limits the amount of storage that the volume
2688
+ # can consume to the configured amount, but does not guarantee the
2689
+ # space will be available on the parent volume. To guarantee quota
2690
+ # space, you must also set `StorageCapacityReservationGiB`. To *not*
2691
+ # specify a storage capacity quota, set this to `-1`.
2692
+ #
2693
+ # For more information, see [Volume properties][1] in the *Amazon FSx
2694
+ # for OpenZFS User Guide*.
2695
+ #
2696
+ #
2697
+ #
2698
+ # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/managing-volumes.html#volume-properties
2699
+ # @return [Integer]
2700
+ #
2701
+ # @!attribute [rw] record_size_ki_b
2702
+ # Specifies the suggested block size for a volume in a ZFS dataset, in
2703
+ # kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512,
2704
+ # or 1024 KiB. The default is 128 KiB. We recommend using the default
2705
+ # setting for the majority of use cases. Generally, workloads that
2706
+ # write in fixed small or large record sizes may benefit from setting
2707
+ # a custom record size, like database workloads (small record size) or
2708
+ # media streaming workloads (large record size). For additional
2709
+ # guidance on when to set a custom record size, see [ ZFS Record
2710
+ # size][1] in the *Amazon FSx for OpenZFS User Guide*.
2711
+ #
2712
+ #
2713
+ #
2714
+ # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#record-size-performance
2636
2715
  # @return [Integer]
2637
2716
  #
2638
2717
  # @!attribute [rw] data_compression_type
2639
- # Specifies the method used to compress the data on the volume. Unless
2640
- # the compression type is specified, volumes inherit the
2641
- # `DataCompressionType` value of their parent volume.
2718
+ # Specifies the method used to compress the data on the volume. The
2719
+ # compression type is `NONE` by default.
2642
2720
  #
2643
- # * `NONE` - Doesn't compress the data on the volume.
2721
+ # * `NONE` - Doesn't compress the data on the volume. `NONE` is the
2722
+ # default.
2644
2723
  #
2645
2724
  # * `ZSTD` - Compresses the data in the volume using the Zstandard
2646
- # (ZSTD) compression algorithm. This algorithm reduces the amount of
2647
- # space used on your volume and has very little impact on compute
2648
- # resources.
2725
+ # (ZSTD) compression algorithm. ZSTD compression provides a higher
2726
+ # level of data compression and higher read throughput performance
2727
+ # than LZ4 compression.
2728
+ #
2729
+ # * `LZ4` - Compresses the data in the volume using the LZ4
2730
+ # compression algorithm. LZ4 compression provides a lower level of
2731
+ # compression and higher write throughput performance than ZSTD
2732
+ # compression.
2733
+ #
2734
+ # For more information about volume compression types and the
2735
+ # performance of your Amazon FSx for OpenZFS file system, see [ Tips
2736
+ # for maximizing performance][1] File system and volume settings in
2737
+ # the *Amazon FSx for OpenZFS User Guide*.
2738
+ #
2739
+ #
2740
+ #
2741
+ # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs
2649
2742
  # @return [String]
2650
2743
  #
2651
2744
  # @!attribute [rw] copy_tags_to_snapshots
@@ -2683,6 +2776,7 @@ module Aws::FSx
2683
2776
  :parent_volume_id,
2684
2777
  :storage_capacity_reservation_gi_b,
2685
2778
  :storage_capacity_quota_gi_b,
2779
+ :record_size_ki_b,
2686
2780
  :data_compression_type,
2687
2781
  :copy_tags_to_snapshots,
2688
2782
  :origin_snapshot,
@@ -3013,7 +3107,8 @@ module Aws::FSx
3013
3107
  # parent_volume_id: "VolumeId", # required
3014
3108
  # storage_capacity_reservation_gi_b: 1,
3015
3109
  # storage_capacity_quota_gi_b: 1,
3016
- # data_compression_type: "NONE", # accepts NONE, ZSTD
3110
+ # record_size_ki_b: 1,
3111
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
3017
3112
  # copy_tags_to_snapshots: false,
3018
3113
  # origin_snapshot: {
3019
3114
  # snapshot_arn: "ResourceARN", # required
@@ -3176,6 +3271,13 @@ module Aws::FSx
3176
3271
  # from or imported to. This file system directory can be linked to
3177
3272
  # only one Amazon S3 bucket, and no other S3 bucket can be linked to
3178
3273
  # the directory.
3274
+ #
3275
+ # <note markdown="1"> If you specify only a forward slash (`/`) as the file system path,
3276
+ # you can link only 1 data repository to the file system. You can only
3277
+ # specify "/" as the file system path for the first data repository
3278
+ # associated with a file system.
3279
+ #
3280
+ # </note>
3179
3281
  # @return [String]
3180
3282
  #
3181
3283
  # @!attribute [rw] data_repository_path
@@ -3821,8 +3923,8 @@ module Aws::FSx
3821
3923
  include Aws::Structure
3822
3924
  end
3823
3925
 
3824
- # The configuration object for the OpenZFS file system used in the
3825
- # `DeleteFileSystem` operation.
3926
+ # The configuration object for the Amazon FSx for OpenZFS file system
3927
+ # used in the `DeleteFileSystem` operation.
3826
3928
  #
3827
3929
  # @note When making an API call, you may pass DeleteFileSystemOpenZFSConfiguration
3828
3930
  # data as a hash:
@@ -3835,25 +3937,34 @@ module Aws::FSx
3835
3937
  # value: "TagValue", # required
3836
3938
  # },
3837
3939
  # ],
3940
+ # options: ["DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"], # accepts DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
3838
3941
  # }
3839
3942
  #
3840
3943
  # @!attribute [rw] skip_final_backup
3841
3944
  # By default, Amazon FSx for OpenZFS takes a final backup on your
3842
3945
  # behalf when the `DeleteFileSystem` operation is invoked. Doing this
3843
3946
  # helps protect you from data loss, and we highly recommend taking the
3844
- # final backup. If you want to skip this backup, use this value to do
3845
- # so.
3947
+ # final backup. If you want to skip taking a final backup, set this
3948
+ # value to `true`.
3846
3949
  # @return [Boolean]
3847
3950
  #
3848
3951
  # @!attribute [rw] final_backup_tags
3849
- # A list of `Tag` values, with a maximum of 50 elements.
3952
+ # A list of tags to apply to the file system's final backup.
3850
3953
  # @return [Array<Types::Tag>]
3851
3954
  #
3955
+ # @!attribute [rw] options
3956
+ # To delete a file system if there are child volumes present below the
3957
+ # root volume, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS`. If
3958
+ # your file system has child volumes and you don't use this option,
3959
+ # the delete request will fail.
3960
+ # @return [Array<String>]
3961
+ #
3852
3962
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemOpenZFSConfiguration AWS API Documentation
3853
3963
  #
3854
3964
  class DeleteFileSystemOpenZFSConfiguration < Struct.new(
3855
3965
  :skip_final_backup,
3856
- :final_backup_tags)
3966
+ :final_backup_tags,
3967
+ :options)
3857
3968
  SENSITIVE = []
3858
3969
  include Aws::Structure
3859
3970
  end
@@ -3913,6 +4024,7 @@ module Aws::FSx
3913
4024
  # value: "TagValue", # required
3914
4025
  # },
3915
4026
  # ],
4027
+ # options: ["DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"], # accepts DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
3916
4028
  # },
3917
4029
  # }
3918
4030
  #
@@ -5052,23 +5164,25 @@ module Aws::FSx
5052
5164
  # @return [String]
5053
5165
  #
5054
5166
  # @!attribute [rw] kms_key_id
5055
- # The ID of the Key Management Service (KMS) key used to encrypt the
5056
- # file system's data for Amazon FSx for Windows File Server file
5057
- # systems, Amazon FSx for NetApp ONTAP file systems, and `PERSISTENT`
5058
- # Amazon FSx for Lustre file systems at rest. If this ID isn't
5059
- # specified, the Amazon FSx-managed key for your account is used. The
5060
- # scratch Amazon FSx for Lustre file systems are always encrypted at
5061
- # rest using the Amazon FSx-managed key for your account. For more
5062
- # information, see [Encrypt][1] in the *Key Management Service API
5063
- # Reference*.
5167
+ # The ID of the Key Management Service (KMS) key used to encrypt
5168
+ # Amazon FSx file system data. Used as follows with Amazon FSx file
5169
+ # system types:
5064
5170
  #
5171
+ # * Amazon FSx for Lustre `PERSISTENT_1` and `PERSISTENT_2` deployment
5172
+ # types only.
5065
5173
  #
5174
+ # `SCRATCH_1` and `SCRATCH_2` types are encrypted using the Amazon
5175
+ # FSx service KMS key for your account.
5066
5176
  #
5067
- # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
5177
+ # * Amazon FSx for NetApp ONTAP
5178
+ #
5179
+ # * Amazon FSx for OpenZFS
5180
+ #
5181
+ # * Amazon FSx for Windows File Server
5068
5182
  # @return [String]
5069
5183
  #
5070
5184
  # @!attribute [rw] resource_arn
5071
- # The Amazon Resource Name (ARN) for the file system resource.
5185
+ # The Amazon Resource Name (ARN) of the file system resource.
5072
5186
  # @return [String]
5073
5187
  #
5074
5188
  # @!attribute [rw] tags
@@ -5082,7 +5196,8 @@ module Aws::FSx
5082
5196
  # @return [Array<Types::Tag>]
5083
5197
  #
5084
5198
  # @!attribute [rw] windows_configuration
5085
- # The configuration for this FSx for Windows File Server file system.
5199
+ # The configuration for this Amazon FSx for Windows File Server file
5200
+ # system.
5086
5201
  # @return [Types::WindowsFileSystemConfiguration]
5087
5202
  #
5088
5203
  # @!attribute [rw] lustre_configuration
@@ -5097,7 +5212,7 @@ module Aws::FSx
5097
5212
  # @return [Array<Types::AdministrativeAction>]
5098
5213
  #
5099
5214
  # @!attribute [rw] ontap_configuration
5100
- # The configuration for this FSx for ONTAP file system.
5215
+ # The configuration for this Amazon FSx for NetApp ONTAP file system.
5101
5216
  # @return [Types::OntapFileSystemConfiguration]
5102
5217
  #
5103
5218
  # @!attribute [rw] file_system_type_version
@@ -5823,6 +5938,11 @@ module Aws::FSx
5823
5938
  # @!attribute [rw] endpoint_ip_address_range
5824
5939
  # The IP address range in which the endpoints to access your file
5825
5940
  # system are created.
5941
+ #
5942
+ # The Endpoint IP address range you select for your file system must
5943
+ # exist outside the VPC's CIDR range and must be at least /30 or
5944
+ # larger. If you do not specify this optional parameter, Amazon FSx
5945
+ # will automatically select a CIDR block for you.
5826
5946
  # @return [String]
5827
5947
  #
5828
5948
  # @!attribute [rw] endpoints
@@ -5852,7 +5972,8 @@ module Aws::FSx
5852
5972
  # @return [Array<String>]
5853
5973
  #
5854
5974
  # @!attribute [rw] throughput_capacity
5855
- # The sustained throughput of an Amazon FSx file system in MBps.
5975
+ # The sustained throughput of an Amazon FSx file system in Megabytes
5976
+ # per second (MBps).
5856
5977
  # @return [Integer]
5857
5978
  #
5858
5979
  # @!attribute [rw] weekly_maintenance_start_time
@@ -5983,8 +6104,8 @@ module Aws::FSx
5983
6104
  include Aws::Structure
5984
6105
  end
5985
6106
 
5986
- # Specifies who can mount the file system and the options that can be
5987
- # used while mounting the file system.
6107
+ # Specifies who can mount an OpenZFS file system and the options
6108
+ # available while mounting the file system.
5988
6109
  #
5989
6110
  # @note When making an API call, you may pass OpenZFSClientConfiguration
5990
6111
  # data as a hash:
@@ -5997,7 +6118,7 @@ module Aws::FSx
5997
6118
  # @!attribute [rw] clients
5998
6119
  # A value that specifies who can mount the file system. You can
5999
6120
  # provide a wildcard character (`*`), an IP address (`0.0.0.0`), or a
6000
- # CIDR address (`192.0.2.0/24`. By default, Amazon FSx uses the
6121
+ # CIDR address (`192.0.2.0/24`). By default, Amazon FSx uses the
6001
6122
  # wildcard character when specifying the client.
6002
6123
  # @return [String]
6003
6124
  #
@@ -6007,10 +6128,9 @@ module Aws::FSx
6007
6128
  # [exports(5) - Linux man page][1]. When choosing your options,
6008
6129
  # consider the following:
6009
6130
  #
6010
- # * `crossmount` is used by default. If you don't specify
6011
- # `crossmount` when changing the client configuration, you won't be
6012
- # able to see or access snapshots in your file system's snapshot
6013
- # directory.
6131
+ # * `crossmnt` is used by default. If you don't specify `crossmnt`
6132
+ # when changing the client configuration, you won't be able to see
6133
+ # or access snapshots in your file system's snapshot directory.
6014
6134
  #
6015
6135
  # * `sync` is used by default. If you instead specify `async`, the
6016
6136
  # system acknowledges writes before writing to disk. If the system
@@ -6037,7 +6157,8 @@ module Aws::FSx
6037
6157
  # data as a hash:
6038
6158
  #
6039
6159
  # {
6040
- # data_compression_type: "NONE", # accepts NONE, ZSTD
6160
+ # record_size_ki_b: 1,
6161
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
6041
6162
  # nfs_exports: [
6042
6163
  # {
6043
6164
  # client_configurations: [ # required
@@ -6059,17 +6180,36 @@ module Aws::FSx
6059
6180
  # read_only: false,
6060
6181
  # }
6061
6182
  #
6183
+ # @!attribute [rw] record_size_ki_b
6184
+ # Specifies the record size of an OpenZFS root volume, in kibibytes
6185
+ # (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024
6186
+ # KiB. The default is 128 KiB. Most workloads should use the default
6187
+ # record size. Database workflows can benefit from a smaller record
6188
+ # size, while streaming workflows can benefit from a larger record
6189
+ # size. For additional guidance on setting a custom record size, see [
6190
+ # Tips for maximizing performance][1] in the *Amazon FSx for OpenZFS
6191
+ # User Guide*.
6192
+ #
6193
+ #
6194
+ #
6195
+ # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs
6196
+ # @return [Integer]
6197
+ #
6062
6198
  # @!attribute [rw] data_compression_type
6063
- # Specifies the method used to compress the data on the volume. Unless
6064
- # the compression type is specified, volumes inherit the
6065
- # `DataCompressionType` value of their parent volume.
6199
+ # Specifies the method used to compress the data on the volume. The
6200
+ # compression type is `NONE` by default.
6201
+ #
6202
+ # * `NONE` - Doesn't compress the data on the volume. `NONE` is the
6203
+ # default.
6066
6204
  #
6067
- # * `NONE` - Doesn't compress the data on the volume.
6205
+ # * `ZSTD` - Compresses the data in the volume using the Zstandard
6206
+ # (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides
6207
+ # a better compression ratio to minimize on-disk storage
6208
+ # utilization.
6068
6209
  #
6069
- # * `ZSTD` - Compresses the data in the volume using the ZStandard
6070
- # (ZSTD) compression algorithm. This algorithm reduces the amount of
6071
- # space used on your volume and has very little impact on compute
6072
- # resources.
6210
+ # * `LZ4` - Compresses the data in the volume using the LZ4
6211
+ # compression algorithm. Compared to Z-Standard, LZ4 is less
6212
+ # compute-intensive and delivers higher write throughput speeds.
6073
6213
  # @return [String]
6074
6214
  #
6075
6215
  # @!attribute [rw] nfs_exports
@@ -6083,12 +6223,13 @@ module Aws::FSx
6083
6223
  #
6084
6224
  # @!attribute [rw] copy_tags_to_snapshots
6085
6225
  # A Boolean value indicating whether tags for the volume should be
6086
- # copied to snapshots. This value defaults to `false`. If it's set to
6087
- # `true`, all tags for the volume are copied to snapshots where the
6088
- # user doesn't specify tags. If this value is `true` and you specify
6089
- # one or more tags, only the specified tags are copied to snapshots.
6090
- # If you specify one or more tags when creating the snapshot, no tags
6091
- # are copied from the volume, regardless of this value.
6226
+ # copied to snapshots of the volume. This value defaults to `false`.
6227
+ # If it's set to `true`, all tags for the volume are copied to
6228
+ # snapshots where the user doesn't specify tags. If this value is
6229
+ # `true` and you specify one or more tags, only the specified tags are
6230
+ # copied to snapshots. If you specify one or more tags when creating
6231
+ # the snapshot, no tags are copied from the volume, regardless of this
6232
+ # value.
6092
6233
  # @return [Boolean]
6093
6234
  #
6094
6235
  # @!attribute [rw] read_only
@@ -6100,6 +6241,7 @@ module Aws::FSx
6100
6241
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSCreateRootVolumeConfiguration AWS API Documentation
6101
6242
  #
6102
6243
  class OpenZFSCreateRootVolumeConfiguration < Struct.new(
6244
+ :record_size_ki_b,
6103
6245
  :data_compression_type,
6104
6246
  :nfs_exports,
6105
6247
  :user_and_group_quotas,
@@ -6152,8 +6294,8 @@ module Aws::FSx
6152
6294
  #
6153
6295
  # @!attribute [rw] throughput_capacity
6154
6296
  # The throughput of an Amazon FSx file system, measured in megabytes
6155
- # per second (MBps), in 2 to the nth increments, between 2^3 (8) and
6156
- # 2^11 (2048).
6297
+ # per second (MBps). Valid values are 64, 128, 256, 512, 1024, 2048,
6298
+ # 3072, or 4096 MB/s.
6157
6299
  # @return [Integer]
6158
6300
  #
6159
6301
  # @!attribute [rw] weekly_maintenance_start_time
@@ -6202,8 +6344,8 @@ module Aws::FSx
6202
6344
  include Aws::Structure
6203
6345
  end
6204
6346
 
6205
- # The Network File System NFS) configurations for mounting an Amazon FSx
6206
- # for OpenZFS file system.
6347
+ # The Network File System (NFS) configurations for mounting an Amazon
6348
+ # FSx for OpenZFS file system.
6207
6349
  #
6208
6350
  # @note When making an API call, you may pass OpenZFSNfsExport
6209
6351
  # data as a hash:
@@ -6325,17 +6467,29 @@ module Aws::FSx
6325
6467
  # on the parent volume.
6326
6468
  # @return [Integer]
6327
6469
  #
6470
+ # @!attribute [rw] record_size_ki_b
6471
+ # The record size of an OpenZFS volume, in kibibytes (KiB). Valid
6472
+ # values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default
6473
+ # is 128 KiB. Most workloads should use the default record size. For
6474
+ # guidance on when to set a custom record size, see the *Amazon FSx
6475
+ # for OpenZFS User Guide*.
6476
+ # @return [Integer]
6477
+ #
6328
6478
  # @!attribute [rw] data_compression_type
6329
- # The method used to compress the data on the volume. Unless a
6330
- # compression type is specified, volumes inherit the
6331
- # `DataCompressionType` value of their parent volume.
6479
+ # Specifies the method used to compress the data on the volume. The
6480
+ # compression type is `NONE` by default.
6332
6481
  #
6333
- # * `NONE` - Doesn't compress the data on the volume.
6482
+ # * `NONE` - Doesn't compress the data on the volume. `NONE` is the
6483
+ # default.
6334
6484
  #
6335
6485
  # * `ZSTD` - Compresses the data in the volume using the Zstandard
6336
- # (ZSTD) compression algorithm. This algorithm reduces the amount of
6337
- # space used on your volume and has very little impact on compute
6338
- # resources.
6486
+ # (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides
6487
+ # a better compression ratio to minimize on-disk storage
6488
+ # utilization.
6489
+ #
6490
+ # * `LZ4` - Compresses the data in the volume using the LZ4
6491
+ # compression algorithm. Compared to Z-Standard, LZ4 is less
6492
+ # compute-intensive and delivers higher write throughput speeds.
6339
6493
  # @return [String]
6340
6494
  #
6341
6495
  # @!attribute [rw] copy_tags_to_snapshots
@@ -6374,6 +6528,7 @@ module Aws::FSx
6374
6528
  :volume_path,
6375
6529
  :storage_capacity_reservation_gi_b,
6376
6530
  :storage_capacity_quota_gi_b,
6531
+ :record_size_ki_b,
6377
6532
  :data_compression_type,
6378
6533
  :copy_tags_to_snapshots,
6379
6534
  :origin_snapshot,
@@ -6810,6 +6965,10 @@ module Aws::FSx
6810
6965
  # * `AVAILABLE` - The snapshot is fully available.
6811
6966
  # @return [String]
6812
6967
  #
6968
+ # @!attribute [rw] lifecycle_transition_reason
6969
+ # Describes why a resource lifecycle state changed.
6970
+ # @return [Types::LifecycleTransitionReason]
6971
+ #
6813
6972
  # @!attribute [rw] tags
6814
6973
  # A list of `Tag` values, with a maximum of 50 elements.
6815
6974
  # @return [Array<Types::Tag>]
@@ -6829,6 +6988,7 @@ module Aws::FSx
6829
6988
  :volume_id,
6830
6989
  :creation_time,
6831
6990
  :lifecycle,
6991
+ :lifecycle_transition_reason,
6832
6992
  :tags,
6833
6993
  :administrative_actions)
6834
6994
  SENSITIVE = []
@@ -6901,7 +7061,7 @@ module Aws::FSx
6901
7061
  end
6902
7062
 
6903
7063
  # Describes the Amazon FSx for NetApp ONTAP storage virtual machine
6904
- # (SVM) configuraton.
7064
+ # (SVM) configuration.
6905
7065
  #
6906
7066
  # @!attribute [rw] active_directory_configuration
6907
7067
  # Describes the Microsoft Active Directory configuration to which the
@@ -7029,8 +7189,7 @@ module Aws::FSx
7029
7189
  include Aws::Structure
7030
7190
  end
7031
7191
 
7032
- # No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied
7033
- # parameters.
7192
+ # No FSx for ONTAP SVMs were found based upon the supplied parameters.
7034
7193
  #
7035
7194
  # @!attribute [rw] message
7036
7195
  # A detailed error message.
@@ -7516,6 +7675,7 @@ module Aws::FSx
7516
7675
  # mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
7517
7676
  # iops: 1,
7518
7677
  # },
7678
+ # throughput_capacity: 1,
7519
7679
  # }
7520
7680
  #
7521
7681
  # @!attribute [rw] automatic_backup_retention_days
@@ -7560,6 +7720,12 @@ module Aws::FSx
7560
7720
  # `USER_PROVISIONED` IOPS, the total number of SSD IOPS provisioned.
7561
7721
  # @return [Types::DiskIopsConfiguration]
7562
7722
  #
7723
+ # @!attribute [rw] throughput_capacity
7724
+ # Specifies the throughput of an FSx for NetApp ONTAP file system,
7725
+ # measured in megabytes per second (MBps). Valid values are 64, 128,
7726
+ # 256, 512, 1024, 2048, 3072, or 4096 MB/s.
7727
+ # @return [Integer]
7728
+ #
7563
7729
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemOntapConfiguration AWS API Documentation
7564
7730
  #
7565
7731
  class UpdateFileSystemOntapConfiguration < Struct.new(
@@ -7567,7 +7733,8 @@ module Aws::FSx
7567
7733
  :daily_automatic_backup_start_time,
7568
7734
  :fsx_admin_password,
7569
7735
  :weekly_maintenance_start_time,
7570
- :disk_iops_configuration)
7736
+ :disk_iops_configuration,
7737
+ :throughput_capacity)
7571
7738
  SENSITIVE = [:fsx_admin_password]
7572
7739
  include Aws::Structure
7573
7740
  end
@@ -7625,8 +7792,8 @@ module Aws::FSx
7625
7792
  #
7626
7793
  # @!attribute [rw] throughput_capacity
7627
7794
  # The throughput of an Amazon FSx file system, measured in megabytes
7628
- # per second (MBps), in 2 to the nth increments, between 2^3 (8) and
7629
- # 2^12 (4096).
7795
+ # per second (MBps). Valid values are 64, 128, 256, 512, 1024, 2048,
7796
+ # 3072, or 4096 MB/s.
7630
7797
  # @return [Integer]
7631
7798
  #
7632
7799
  # @!attribute [rw] weekly_maintenance_start_time
@@ -7714,6 +7881,7 @@ module Aws::FSx
7714
7881
  # mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
7715
7882
  # iops: 1,
7716
7883
  # },
7884
+ # throughput_capacity: 1,
7717
7885
  # },
7718
7886
  # open_zfs_configuration: {
7719
7887
  # automatic_backup_retention_days: 1,
@@ -7987,7 +8155,8 @@ module Aws::FSx
7987
8155
  # {
7988
8156
  # storage_capacity_reservation_gi_b: 1,
7989
8157
  # storage_capacity_quota_gi_b: 1,
7990
- # data_compression_type: "NONE", # accepts NONE, ZSTD
8158
+ # record_size_ki_b: 1,
8159
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
7991
8160
  # nfs_exports: [
7992
8161
  # {
7993
8162
  # client_configurations: [ # required
@@ -8011,26 +8180,47 @@ module Aws::FSx
8011
8180
  # @!attribute [rw] storage_capacity_reservation_gi_b
8012
8181
  # The amount of storage in gibibytes (GiB) to reserve from the parent
8013
8182
  # volume. You can't reserve more storage than the parent volume has
8014
- # reserved.
8183
+ # reserved. You can specify a value of `-1` to unset a volume's
8184
+ # storage capacity reservation.
8015
8185
  # @return [Integer]
8016
8186
  #
8017
8187
  # @!attribute [rw] storage_capacity_quota_gi_b
8018
8188
  # The maximum amount of storage in gibibytes (GiB) that the volume can
8019
8189
  # use from its parent. You can specify a quota larger than the storage
8020
- # on the parent volume.
8190
+ # on the parent volume. You can specify a value of `-1` to unset a
8191
+ # volume's storage capacity quota.
8192
+ # @return [Integer]
8193
+ #
8194
+ # @!attribute [rw] record_size_ki_b
8195
+ # Specifies the record size of an OpenZFS volume, in kibibytes (KiB).
8196
+ # Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The
8197
+ # default is 128 KiB. Most workloads should use the default record
8198
+ # size. Database workflows can benefit from a smaller record size,
8199
+ # while streaming workflows can benefit from a larger record size. For
8200
+ # additional guidance on when to set a custom record size, see [ Tips
8201
+ # for maximizing performance][1] in the *Amazon FSx for OpenZFS User
8202
+ # Guide*.
8203
+ #
8204
+ #
8205
+ #
8206
+ # [1]: https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs
8021
8207
  # @return [Integer]
8022
8208
  #
8023
8209
  # @!attribute [rw] data_compression_type
8024
- # Specifies the method used to compress the data on the volume. Unless
8025
- # the compression type is specified, volumes inherit the
8026
- # `DataCompressionType` value of their parent volume.
8210
+ # Specifies the method used to compress the data on the volume. The
8211
+ # compression type is `NONE` by default.
8027
8212
  #
8028
- # * `NONE` - Doesn't compress the data on the volume.
8213
+ # * `NONE` - Doesn't compress the data on the volume. `NONE` is the
8214
+ # default.
8029
8215
  #
8030
8216
  # * `ZSTD` - Compresses the data in the volume using the Zstandard
8031
- # (ZSTD) compression algorithm. This algorithm reduces the amount of
8032
- # space used on your volume and has very little impact on compute
8033
- # resources.
8217
+ # (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides
8218
+ # a better compression ratio to minimize on-disk storage
8219
+ # utilization.
8220
+ #
8221
+ # * `LZ4` - Compresses the data in the volume using the LZ4
8222
+ # compression algorithm. Compared to Z-Standard, LZ4 is less
8223
+ # compute-intensive and delivers higher write throughput speeds.
8034
8224
  # @return [String]
8035
8225
  #
8036
8226
  # @!attribute [rw] nfs_exports
@@ -8052,6 +8242,7 @@ module Aws::FSx
8052
8242
  class UpdateOpenZFSVolumeConfiguration < Struct.new(
8053
8243
  :storage_capacity_reservation_gi_b,
8054
8244
  :storage_capacity_quota_gi_b,
8245
+ :record_size_ki_b,
8055
8246
  :data_compression_type,
8056
8247
  :nfs_exports,
8057
8248
  :user_and_group_quotas,
@@ -8164,7 +8355,7 @@ module Aws::FSx
8164
8355
 
8165
8356
  # @!attribute [rw] storage_virtual_machine
8166
8357
  # Describes the Amazon FSx for NetApp ONTAP storage virtual machine
8167
- # (SVM) configuraton.
8358
+ # (SVM) configuration.
8168
8359
  # @return [Types::StorageVirtualMachine]
8169
8360
  #
8170
8361
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachineResponse AWS API Documentation
@@ -8224,7 +8415,8 @@ module Aws::FSx
8224
8415
  # open_zfs_configuration: {
8225
8416
  # storage_capacity_reservation_gi_b: 1,
8226
8417
  # storage_capacity_quota_gi_b: 1,
8227
- # data_compression_type: "NONE", # accepts NONE, ZSTD
8418
+ # record_size_ki_b: 1,
8419
+ # data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
8228
8420
  # nfs_exports: [
8229
8421
  # {
8230
8422
  # client_configurations: [ # required
@@ -8427,8 +8619,7 @@ module Aws::FSx
8427
8619
  include Aws::Structure
8428
8620
  end
8429
8621
 
8430
- # No Amazon FSx for NetApp ONTAP volumes were found based upon the
8431
- # supplied parameters.
8622
+ # No Amazon FSx volumes were found based upon the supplied parameters.
8432
8623
  #
8433
8624
  # @!attribute [rw] message
8434
8625
  # A detailed error message.