aws-sdk-fsx 1.41.0 → 1.45.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.
@@ -18,16 +18,16 @@ module Aws::FSx
18
18
  # @return [String]
19
19
  #
20
20
  # @!attribute [rw] active_directory_id
21
- # The ID of the AWS Managed Microsoft Active Directory instance to
22
- # which the file system is joined.
21
+ # The ID of the Amazon Web Services Managed Microsoft Active Directory
22
+ # instance to which the file system is joined.
23
23
  # @return [String]
24
24
  #
25
25
  # @!attribute [rw] resource_arn
26
26
  # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
27
- # identify AWS resources. We require an ARN when you need to specify a
28
- # resource unambiguously across all of AWS. For more information, see
29
- # [Amazon Resource Names (ARNs) and AWS Service Namespaces][1] in the
30
- # *AWS General Reference*.
27
+ # identify Amazon Web Services resources. We require an ARN when you
28
+ # need to specify a resource unambiguously across all of Amazon Web
29
+ # Services. For more information, see [Amazon Resource Names
30
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
31
31
  #
32
32
  #
33
33
  #
@@ -159,6 +159,10 @@ module Aws::FSx
159
159
  # Provides information about a failed administrative action.
160
160
  # @return [Types::AdministrativeActionFailureDetails]
161
161
  #
162
+ # @!attribute [rw] target_volume_values
163
+ # Describes an Amazon FSx for NetApp ONTAP volume.
164
+ # @return [Types::Volume]
165
+ #
162
166
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AdministrativeAction AWS API Documentation
163
167
  #
164
168
  class AdministrativeAction < Struct.new(
@@ -167,7 +171,8 @@ module Aws::FSx
167
171
  :request_time,
168
172
  :status,
169
173
  :target_file_system_values,
170
- :failure_details)
174
+ :failure_details,
175
+ :target_volume_values)
171
176
  SENSITIVE = []
172
177
  include Aws::Structure
173
178
  end
@@ -232,7 +237,7 @@ module Aws::FSx
232
237
  # * DELETING - Amazon FSx is disassociating the DNS alias from the
233
238
  # file system and deleting it.
234
239
  #
235
- # * DELETE\_FAILED - Amazon FSx was unable to disassocate the DNS
240
+ # * DELETE\_FAILED - Amazon FSx was unable to disassociate the DNS
236
241
  # alias from the file system.
237
242
  # @return [String]
238
243
  #
@@ -260,8 +265,8 @@ module Aws::FSx
260
265
  # @!attribute [rw] client_request_token
261
266
  # (Optional) An idempotency token for resource creation, in a string
262
267
  # of up to 64 ASCII characters. This token is automatically filled on
263
- # your behalf when you use the AWS Command Line Interface (AWS CLI) or
264
- # an AWS SDK.
268
+ # your behalf when you use the Command Line Interface (CLI) or an
269
+ # Amazon Web Services SDK.
265
270
  #
266
271
  # **A suitable default value is auto-generated.** You should normally
267
272
  # not need to pass this option.
@@ -322,7 +327,8 @@ module Aws::FSx
322
327
  include Aws::Structure
323
328
  end
324
329
 
325
- # A backup of an Amazon FSx file system.
330
+ # A backup of an Amazon FSx for Windows File Server or Amazon FSx for
331
+ # Lustre file system, or of an Amazon FSx for NetApp ONTAP volume.
326
332
  #
327
333
  # @!attribute [rw] backup_id
328
334
  # The ID of the backup.
@@ -366,8 +372,8 @@ module Aws::FSx
366
372
  # @return [Time]
367
373
  #
368
374
  # @!attribute [rw] kms_key_id
369
- # The ID of the AWS Key Management Service (AWS KMS) key used to
370
- # encrypt the backup of the Amazon FSx file system's data at rest.
375
+ # The ID of the Key Management Service (KMS) key used to encrypt the
376
+ # backup of the Amazon FSx file system's data at rest.
371
377
  # @return [String]
372
378
  #
373
379
  # @!attribute [rw] resource_arn
@@ -389,8 +395,8 @@ module Aws::FSx
389
395
  # @return [Types::ActiveDirectoryBackupAttributes]
390
396
  #
391
397
  # @!attribute [rw] owner_id
392
- # An AWS account ID. This ID is a 12-digit number that you use to
393
- # construct Amazon Resource Names (ARNs) for resources.
398
+ # An Amazon Web Services account ID. This ID is a 12-digit number that
399
+ # you use to construct Amazon Resource Names (ARNs) for resources.
394
400
  # @return [String]
395
401
  #
396
402
  # @!attribute [rw] source_backup_id
@@ -402,6 +408,14 @@ module Aws::FSx
402
408
  # this backup is copied.
403
409
  # @return [String]
404
410
  #
411
+ # @!attribute [rw] resource_type
412
+ # Specifies the resource type that is backed up.
413
+ # @return [String]
414
+ #
415
+ # @!attribute [rw] volume
416
+ # Describes an Amazon FSx for NetApp ONTAP volume.
417
+ # @return [Types::Volume]
418
+ #
405
419
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Backup AWS API Documentation
406
420
  #
407
421
  class Backup < Struct.new(
@@ -418,7 +432,9 @@ module Aws::FSx
418
432
  :directory_information,
419
433
  :owner_id,
420
434
  :source_backup_id,
421
- :source_backup_region)
435
+ :source_backup_region,
436
+ :resource_type,
437
+ :volume)
422
438
  SENSITIVE = []
423
439
  include Aws::Structure
424
440
  end
@@ -656,8 +672,8 @@ module Aws::FSx
656
672
  # @!attribute [rw] client_request_token
657
673
  # (Optional) An idempotency token for resource creation, in a string
658
674
  # of up to 64 ASCII characters. This token is automatically filled on
659
- # your behalf when you use the AWS Command Line Interface (AWS CLI) or
660
- # an AWS SDK.
675
+ # your behalf when you use the Command Line Interface (CLI) or an
676
+ # Amazon Web Services SDK.
661
677
  #
662
678
  # **A suitable default value is auto-generated.** You should normally
663
679
  # not need to pass this option.
@@ -669,22 +685,22 @@ module Aws::FSx
669
685
  # @return [String]
670
686
  #
671
687
  # @!attribute [rw] source_region
672
- # The source AWS Region of the backup. Specifies the AWS Region from
673
- # which the backup is being copied. The source and destination Regions
674
- # must be in the same AWS partition. If you don't specify a Region,
675
- # it defaults to the Region where the request is sent from (in-Region
676
- # copy).
688
+ # The source Amazon Web Services Region of the backup. Specifies the
689
+ # Amazon Web Services Region from which the backup is being copied.
690
+ # The source and destination Regions must be in the same Amazon Web
691
+ # Services partition. If you don't specify a Region, it defaults to
692
+ # the Region where the request is sent from (in-Region copy).
677
693
  # @return [String]
678
694
  #
679
695
  # @!attribute [rw] kms_key_id
680
- # The ID of the AWS Key Management Service (AWS KMS) key used to
681
- # encrypt the file system's data for Amazon FSx for Windows File
682
- # Server file systems and Amazon FSx for Lustre `PERSISTENT_1` file
683
- # systems at rest. In either case, if not specified, the Amazon FSx
684
- # managed key is used. The Amazon FSx for Lustre `SCRATCH_1` and
685
- # `SCRATCH_2` file systems are always encrypted at rest using Amazon
686
- # FSx managed keys. For more information, see [Encrypt][1] in the *AWS
687
- # Key Management Service API Reference*.
696
+ # The ID of the Key Management Service (KMS) key used to encrypt the
697
+ # file system's data for Amazon FSx for Windows File Server file
698
+ # systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
699
+ # for Lustre `PERSISTENT_1` file systems at rest. If not specified,
700
+ # the Amazon FSx managed key is used. The Amazon FSx for Lustre
701
+ # `SCRATCH_1` and `SCRATCH_2` file systems are always encrypted at
702
+ # rest using Amazon FSx managed keys. For more information, see
703
+ # [Encrypt][1] in the *Key Management Service API Reference*.
688
704
  #
689
705
  #
690
706
  #
@@ -721,7 +737,8 @@ module Aws::FSx
721
737
  end
722
738
 
723
739
  # @!attribute [rw] backup
724
- # A backup of an Amazon FSx file system.
740
+ # A backup of an Amazon FSx for Windows File Server or Amazon FSx for
741
+ # Lustre file system, or of an Amazon FSx for NetApp ONTAP volume.
725
742
  # @return [Types::Backup]
726
743
  #
727
744
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopyBackupResponse AWS API Documentation
@@ -738,7 +755,7 @@ module Aws::FSx
738
755
  # data as a hash:
739
756
  #
740
757
  # {
741
- # file_system_id: "FileSystemId", # required
758
+ # file_system_id: "FileSystemId",
742
759
  # client_request_token: "ClientRequestToken",
743
760
  # tags: [
744
761
  # {
@@ -746,6 +763,7 @@ module Aws::FSx
746
763
  # value: "TagValue", # required
747
764
  # },
748
765
  # ],
766
+ # volume_id: "VolumeId",
749
767
  # }
750
768
  #
751
769
  # @!attribute [rw] file_system_id
@@ -755,8 +773,8 @@ module Aws::FSx
755
773
  # @!attribute [rw] client_request_token
756
774
  # (Optional) A string of up to 64 ASCII characters that Amazon FSx
757
775
  # uses to ensure idempotent creation. This string is automatically
758
- # filled on your behalf when you use the AWS Command Line Interface
759
- # (AWS CLI) or an AWS SDK.
776
+ # filled on your behalf when you use the Command Line Interface (CLI)
777
+ # or an Amazon Web Services SDK.
760
778
  #
761
779
  # **A suitable default value is auto-generated.** You should normally
762
780
  # not need to pass this option.
@@ -770,12 +788,17 @@ module Aws::FSx
770
788
  # system tags are copied from the file system to the backup.
771
789
  # @return [Array<Types::Tag>]
772
790
  #
791
+ # @!attribute [rw] volume_id
792
+ # The ID of he FSx for NetApp ONTAP volume to back up.
793
+ # @return [String]
794
+ #
773
795
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupRequest AWS API Documentation
774
796
  #
775
797
  class CreateBackupRequest < Struct.new(
776
798
  :file_system_id,
777
799
  :client_request_token,
778
- :tags)
800
+ :tags,
801
+ :volume_id)
779
802
  SENSITIVE = []
780
803
  include Aws::Structure
781
804
  end
@@ -849,8 +872,8 @@ module Aws::FSx
849
872
  # @!attribute [rw] client_request_token
850
873
  # (Optional) An idempotency token for resource creation, in a string
851
874
  # of up to 64 ASCII characters. This token is automatically filled on
852
- # your behalf when you use the AWS Command Line Interface (AWS CLI) or
853
- # an AWS SDK.
875
+ # your behalf when you use the Command Line Interface (CLI) or an
876
+ # Amazon Web Services SDK.
854
877
  #
855
878
  # **A suitable default value is auto-generated.** You should normally
856
879
  # not need to pass this option.
@@ -941,6 +964,7 @@ module Aws::FSx
941
964
  # },
942
965
  # storage_type: "SSD", # accepts SSD, HDD
943
966
  # kms_key_id: "KmsKeyId",
967
+ # file_system_type_version: "FileSystemTypeVersion",
944
968
  # }
945
969
  #
946
970
  # @!attribute [rw] backup_id
@@ -950,8 +974,8 @@ module Aws::FSx
950
974
  # @!attribute [rw] client_request_token
951
975
  # A string of up to 64 ASCII characters that Amazon FSx uses to ensure
952
976
  # idempotent creation. This string is automatically filled on your
953
- # behalf when you use the AWS Command Line Interface (AWS CLI) or an
954
- # AWS SDK.
977
+ # behalf when you use the Command Line Interface (CLI) or an Amazon
978
+ # Web Services SDK.
955
979
  #
956
980
  # **A suitable default value is auto-generated.** You should normally
957
981
  # not need to pass this option.
@@ -1015,20 +1039,31 @@ module Aws::FSx
1015
1039
  # @return [String]
1016
1040
  #
1017
1041
  # @!attribute [rw] kms_key_id
1018
- # The ID of the AWS Key Management Service (AWS KMS) key used to
1019
- # encrypt the file system's data for Amazon FSx for Windows File
1020
- # Server file systems and Amazon FSx for Lustre `PERSISTENT_1` file
1021
- # systems at rest. In either case, if not specified, the Amazon FSx
1022
- # managed key is used. The Amazon FSx for Lustre `SCRATCH_1` and
1023
- # `SCRATCH_2` file systems are always encrypted at rest using Amazon
1024
- # FSx managed keys. For more information, see [Encrypt][1] in the *AWS
1025
- # Key Management Service API Reference*.
1042
+ # The ID of the Key Management Service (KMS) key used to encrypt the
1043
+ # file system's data for Amazon FSx for Windows File Server file
1044
+ # systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
1045
+ # for Lustre `PERSISTENT_1` file systems at rest. If not specified,
1046
+ # the Amazon FSx managed key is used. The Amazon FSx for Lustre
1047
+ # `SCRATCH_1` and `SCRATCH_2` file systems are always encrypted at
1048
+ # rest using Amazon FSx managed keys. For more information, see
1049
+ # [Encrypt][1] in the *Key Management Service API Reference*.
1026
1050
  #
1027
1051
  #
1028
1052
  #
1029
1053
  # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
1030
1054
  # @return [String]
1031
1055
  #
1056
+ # @!attribute [rw] file_system_type_version
1057
+ # Sets the version for the Amazon FSx for Lustre file system you're
1058
+ # creating from a backup. Valid values are `2.10` and `2.12`.
1059
+ #
1060
+ # You don't need to specify `FileSystemTypeVersion` because it will
1061
+ # be applied using the backup's `FileSystemTypeVersion` setting. If
1062
+ # you choose to specify `FileSystemTypeVersion` when creating from
1063
+ # backup, the value must match the backup's `FileSystemTypeVersion`
1064
+ # setting.
1065
+ # @return [String]
1066
+ #
1032
1067
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupRequest AWS API Documentation
1033
1068
  #
1034
1069
  class CreateFileSystemFromBackupRequest < Struct.new(
@@ -1040,7 +1075,8 @@ module Aws::FSx
1040
1075
  :windows_configuration,
1041
1076
  :lustre_configuration,
1042
1077
  :storage_type,
1043
- :kms_key_id)
1078
+ :kms_key_id,
1079
+ :file_system_type_version)
1044
1080
  SENSITIVE = []
1045
1081
  include Aws::Structure
1046
1082
  end
@@ -1146,8 +1182,8 @@ module Aws::FSx
1146
1182
  #
1147
1183
  # Encryption of data in-transit for `SCRATCH_2` and `PERSISTENT_1`
1148
1184
  # deployment types is supported when accessed from supported instance
1149
- # types in supported AWS Regions. To learn more, [Encrypting Data in
1150
- # Transit][3].
1185
+ # types in supported Amazon Web Services Regions. To learn more,
1186
+ # [Encrypting Data in Transit][3].
1151
1187
  #
1152
1188
  #
1153
1189
  #
@@ -1275,6 +1311,117 @@ module Aws::FSx
1275
1311
  include Aws::Structure
1276
1312
  end
1277
1313
 
1314
+ # The ONTAP configuration properties of the FSx for NetApp ONTAP file
1315
+ # system that you are creating.
1316
+ #
1317
+ # @note When making an API call, you may pass CreateFileSystemOntapConfiguration
1318
+ # data as a hash:
1319
+ #
1320
+ # {
1321
+ # automatic_backup_retention_days: 1,
1322
+ # daily_automatic_backup_start_time: "DailyTime",
1323
+ # deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1
1324
+ # endpoint_ip_address_range: "IpAddressRange",
1325
+ # fsx_admin_password: "AdminPassword",
1326
+ # disk_iops_configuration: {
1327
+ # mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
1328
+ # iops: 1,
1329
+ # },
1330
+ # preferred_subnet_id: "SubnetId",
1331
+ # route_table_ids: ["RouteTableId"],
1332
+ # throughput_capacity: 1, # required
1333
+ # weekly_maintenance_start_time: "WeeklyTime",
1334
+ # }
1335
+ #
1336
+ # @!attribute [rw] automatic_backup_retention_days
1337
+ # The number of days to retain automatic backups. Setting this to 0
1338
+ # disables automatic backups. You can retain automatic backups for a
1339
+ # maximum of 90 days. The default is 0.
1340
+ # @return [Integer]
1341
+ #
1342
+ # @!attribute [rw] daily_automatic_backup_start_time
1343
+ # A recurring daily time, in the format `HH:MM`. `HH` is the
1344
+ # zero-padded hour of the day (0-23), and `MM` is the zero-padded
1345
+ # minute of the hour. For example, `05:00` specifies 5 AM daily.
1346
+ # @return [String]
1347
+ #
1348
+ # @!attribute [rw] deployment_type
1349
+ # Specifies the ONTAP file system deployment type to use in creating
1350
+ # the file system.
1351
+ # @return [String]
1352
+ #
1353
+ # @!attribute [rw] endpoint_ip_address_range
1354
+ # Specifies the IP address range in which the endpoints to access your
1355
+ # file system will be created. By default, Amazon FSx selects an
1356
+ # unused IP address range for you from the 198.19.* range.
1357
+ # @return [String]
1358
+ #
1359
+ # @!attribute [rw] fsx_admin_password
1360
+ # The ONTAP administrative password for the `fsxadmin` user that you
1361
+ # can use to administer your file system using the ONTAP CLI and REST
1362
+ # API.
1363
+ # @return [String]
1364
+ #
1365
+ # @!attribute [rw] disk_iops_configuration
1366
+ # The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file
1367
+ # system.
1368
+ # @return [Types::DiskIopsConfiguration]
1369
+ #
1370
+ # @!attribute [rw] preferred_subnet_id
1371
+ # The ID for a subnet. A *subnet* is a range of IP addresses in your
1372
+ # virtual private cloud (VPC). For more information, see [VPC and
1373
+ # Subnets][1] in the *Amazon VPC User Guide.*
1374
+ #
1375
+ #
1376
+ #
1377
+ # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html
1378
+ # @return [String]
1379
+ #
1380
+ # @!attribute [rw] route_table_ids
1381
+ # Specifies the VPC route tables in which your file system's
1382
+ # endpoints will be created. You should specify all VPC route tables
1383
+ # associated with the subnets in which your clients are located. By
1384
+ # default, Amazon FSx selects your VPC's default route table.
1385
+ # @return [Array<String>]
1386
+ #
1387
+ # @!attribute [rw] throughput_capacity
1388
+ # Sustained throughput of an Amazon FSx file system in MBps.
1389
+ # @return [Integer]
1390
+ #
1391
+ # @!attribute [rw] weekly_maintenance_start_time
1392
+ # A recurring weekly time, in the format `D:HH:MM`.
1393
+ #
1394
+ # `D` is the day of the week, for which 1 represents Monday and 7
1395
+ # represents Sunday. For further details, see [the ISO-8601 spec as
1396
+ # described on Wikipedia][1].
1397
+ #
1398
+ # `HH` is the zero-padded hour of the day (0-23), and `MM` is the
1399
+ # zero-padded minute of the hour.
1400
+ #
1401
+ # For example, `1:05:00` specifies maintenance at 5 AM Monday.
1402
+ #
1403
+ #
1404
+ #
1405
+ # [1]: https://en.wikipedia.org/wiki/ISO_week_date
1406
+ # @return [String]
1407
+ #
1408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemOntapConfiguration AWS API Documentation
1409
+ #
1410
+ class CreateFileSystemOntapConfiguration < Struct.new(
1411
+ :automatic_backup_retention_days,
1412
+ :daily_automatic_backup_start_time,
1413
+ :deployment_type,
1414
+ :endpoint_ip_address_range,
1415
+ :fsx_admin_password,
1416
+ :disk_iops_configuration,
1417
+ :preferred_subnet_id,
1418
+ :route_table_ids,
1419
+ :throughput_capacity,
1420
+ :weekly_maintenance_start_time)
1421
+ SENSITIVE = [:fsx_admin_password]
1422
+ include Aws::Structure
1423
+ end
1424
+
1278
1425
  # The request object used to create a new Amazon FSx file system.
1279
1426
  #
1280
1427
  # @note When making an API call, you may pass CreateFileSystemRequest
@@ -1282,7 +1429,7 @@ module Aws::FSx
1282
1429
  #
1283
1430
  # {
1284
1431
  # client_request_token: "ClientRequestToken",
1285
- # file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE
1432
+ # file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE, ONTAP
1286
1433
  # storage_capacity: 1, # required
1287
1434
  # storage_type: "SSD", # accepts SSD, HDD
1288
1435
  # subnet_ids: ["SubnetId"], # required
@@ -1332,21 +1479,37 @@ module Aws::FSx
1332
1479
  # drive_cache_type: "NONE", # accepts NONE, READ
1333
1480
  # data_compression_type: "NONE", # accepts NONE, LZ4
1334
1481
  # },
1482
+ # ontap_configuration: {
1483
+ # automatic_backup_retention_days: 1,
1484
+ # daily_automatic_backup_start_time: "DailyTime",
1485
+ # deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1
1486
+ # endpoint_ip_address_range: "IpAddressRange",
1487
+ # fsx_admin_password: "AdminPassword",
1488
+ # disk_iops_configuration: {
1489
+ # mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
1490
+ # iops: 1,
1491
+ # },
1492
+ # preferred_subnet_id: "SubnetId",
1493
+ # route_table_ids: ["RouteTableId"],
1494
+ # throughput_capacity: 1, # required
1495
+ # weekly_maintenance_start_time: "WeeklyTime",
1496
+ # },
1497
+ # file_system_type_version: "FileSystemTypeVersion",
1335
1498
  # }
1336
1499
  #
1337
1500
  # @!attribute [rw] client_request_token
1338
1501
  # A string of up to 64 ASCII characters that Amazon FSx uses to ensure
1339
1502
  # idempotent creation. This string is automatically filled on your
1340
- # behalf when you use the AWS Command Line Interface (AWS CLI) or an
1341
- # AWS SDK.
1503
+ # behalf when you use the Command Line Interface (CLI) or an Amazon
1504
+ # Web Services SDK.
1342
1505
  #
1343
1506
  # **A suitable default value is auto-generated.** You should normally
1344
1507
  # not need to pass this option.
1345
1508
  # @return [String]
1346
1509
  #
1347
1510
  # @!attribute [rw] file_system_type
1348
- # The type of Amazon FSx file system to create, either `WINDOWS` or
1349
- # `LUSTRE`.
1511
+ # The type of Amazon FSx file system to create. Valid values are
1512
+ # `WINDOWS`, `LUSTRE`, and `ONTAP`.
1350
1513
  # @return [String]
1351
1514
  #
1352
1515
  # @!attribute [rw] storage_capacity
@@ -1371,6 +1534,12 @@ module Aws::FSx
1371
1534
  #
1372
1535
  # * If `StorageType=HDD`, valid values are 2000 GiB - 65,536 GiB (64
1373
1536
  # TiB).
1537
+ #
1538
+ # For ONTAP file systems:
1539
+ #
1540
+ # * Valid values are 1024 GiB - 196,608 GiB (192 TiB).
1541
+ #
1542
+ # ^
1374
1543
  # @return [Integer]
1375
1544
  #
1376
1545
  # @!attribute [rw] storage_type
@@ -1378,7 +1547,7 @@ module Aws::FSx
1378
1547
  # values are `SSD` and `HDD`.
1379
1548
  #
1380
1549
  # * Set to `SSD` to use solid state drive storage. SSD is supported on
1381
- # all Windows and Lustre deployment types.
1550
+ # all Windows, Lustre, and ONTAP deployment types.
1382
1551
  #
1383
1552
  # * Set to `HDD` to use hard disk drive storage. HDD is supported on
1384
1553
  # `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment
@@ -1396,13 +1565,15 @@ module Aws::FSx
1396
1565
  #
1397
1566
  # @!attribute [rw] subnet_ids
1398
1567
  # Specifies the IDs of the subnets that the file system will be
1399
- # accessible from. For Windows `MULTI_AZ_1` file system deployment
1400
- # types, provide exactly two subnet IDs, one for the preferred file
1401
- # server and one for the standby file server. You specify one of these
1402
- # subnets as the preferred subnet using the `WindowsConfiguration >
1403
- # PreferredSubnetID` property. For more information, see [
1404
- # Availability and durability: Single-AZ and Multi-AZ file
1405
- # systems][1].
1568
+ # accessible from. For Windows and ONTAP `MULTI_AZ_1` file system
1569
+ # deployment types, provide exactly two subnet IDs, one for the
1570
+ # preferred file server and one for the standby file server. You
1571
+ # specify one of these subnets as the preferred subnet using the
1572
+ # `WindowsConfiguration > PreferredSubnetID` or `OntapConfiguration >
1573
+ # PreferredSubnetID` properties. For more information, see [
1574
+ # Availability and durability: Single-AZ and Multi-AZ file systems][1]
1575
+ # in the *Amazon FSx for Windows User Guide* and [ Availability and
1576
+ # durability][2] in the *Amazon FSx for ONTAP User Guide*.
1406
1577
  #
1407
1578
  # For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment
1408
1579
  # types and Lustre file systems, provide exactly one subnet ID. The
@@ -1411,6 +1582,7 @@ module Aws::FSx
1411
1582
  #
1412
1583
  #
1413
1584
  # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html
1585
+ # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html
1414
1586
  # @return [Array<String>]
1415
1587
  #
1416
1588
  # @!attribute [rw] security_group_ids
@@ -1425,14 +1597,14 @@ module Aws::FSx
1425
1597
  # @return [Array<Types::Tag>]
1426
1598
  #
1427
1599
  # @!attribute [rw] kms_key_id
1428
- # The ID of the AWS Key Management Service (AWS KMS) key used to
1429
- # encrypt the file system's data for Amazon FSx for Windows File
1430
- # Server file systems and Amazon FSx for Lustre `PERSISTENT_1` file
1431
- # systems at rest. In either case, if not specified, the Amazon FSx
1432
- # managed key is used. The Amazon FSx for Lustre `SCRATCH_1` and
1433
- # `SCRATCH_2` file systems are always encrypted at rest using Amazon
1434
- # FSx managed keys. For more information, see [Encrypt][1] in the *AWS
1435
- # Key Management Service API Reference*.
1600
+ # The ID of the Key Management Service (KMS) key used to encrypt the
1601
+ # file system's data for Amazon FSx for Windows File Server file
1602
+ # systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
1603
+ # for Lustre `PERSISTENT_1` file systems at rest. If not specified,
1604
+ # the Amazon FSx managed key is used. The Amazon FSx for Lustre
1605
+ # `SCRATCH_1` and `SCRATCH_2` file systems are always encrypted at
1606
+ # rest using Amazon FSx managed keys. For more information, see
1607
+ # [Encrypt][1] in the *Key Management Service API Reference*.
1436
1608
  #
1437
1609
  #
1438
1610
  #
@@ -1448,6 +1620,22 @@ module Aws::FSx
1448
1620
  # The Lustre configuration for the file system being created.
1449
1621
  # @return [Types::CreateFileSystemLustreConfiguration]
1450
1622
  #
1623
+ # @!attribute [rw] ontap_configuration
1624
+ # The ONTAP configuration properties of the FSx for NetApp ONTAP file
1625
+ # system that you are creating.
1626
+ # @return [Types::CreateFileSystemOntapConfiguration]
1627
+ #
1628
+ # @!attribute [rw] file_system_type_version
1629
+ # Sets the version of the Amazon FSx for Lustre file system you're
1630
+ # creating. Valid values are `2.10` and `2.12`.
1631
+ #
1632
+ # * Set the value to `2.10` to create a Lustre 2.10 file system.
1633
+ #
1634
+ # * Set the value to `2.12` to create a Lustre 2.12 file system.
1635
+ #
1636
+ # Default value is `2.10`.
1637
+ # @return [String]
1638
+ #
1451
1639
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemRequest AWS API Documentation
1452
1640
  #
1453
1641
  class CreateFileSystemRequest < Struct.new(
@@ -1460,7 +1648,9 @@ module Aws::FSx
1460
1648
  :tags,
1461
1649
  :kms_key_id,
1462
1650
  :windows_configuration,
1463
- :lustre_configuration)
1651
+ :lustre_configuration,
1652
+ :ontap_configuration,
1653
+ :file_system_type_version)
1464
1654
  SENSITIVE = []
1465
1655
  include Aws::Structure
1466
1656
  end
@@ -1511,20 +1701,23 @@ module Aws::FSx
1511
1701
  # }
1512
1702
  #
1513
1703
  # @!attribute [rw] active_directory_id
1514
- # The ID for an existing AWS Managed Microsoft Active Directory (AD)
1515
- # instance that the file system should join when it's created.
1704
+ # The ID for an existing Amazon Web Services Managed Microsoft Active
1705
+ # Directory (AD) instance that the file system should join when it's
1706
+ # created.
1516
1707
  # @return [String]
1517
1708
  #
1518
1709
  # @!attribute [rw] self_managed_active_directory_configuration
1519
- # The configuration that Amazon FSx uses to join the Windows File
1520
- # Server instance to your self-managed (including on-premises)
1521
- # Microsoft Active Directory (AD) directory. For more information, see
1522
- # [ Using Amazon FSx with your self-managed Microsoft Active
1523
- # Directory][1].
1710
+ # The configuration that Amazon FSx uses to join a FSx for Windows
1711
+ # File Server file system or an ONTAP storage virtual machine (SVM) to
1712
+ # a self-managed (including on-premises) Microsoft Active Directory
1713
+ # (AD) directory. For more information, see [ Using Amazon FSx with
1714
+ # your self-managed Microsoft Active Directory][1] or [Managing
1715
+ # SVMs][2].
1524
1716
  #
1525
1717
  #
1526
1718
  #
1527
1719
  # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
1720
+ # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
1528
1721
  # @return [Types::SelfManagedActiveDirectoryConfiguration]
1529
1722
  #
1530
1723
  # @!attribute [rw] deployment_type
@@ -1534,8 +1727,9 @@ module Aws::FSx
1534
1727
  # * `MULTI_AZ_1` - Deploys a high availability file system that is
1535
1728
  # configured for Multi-AZ redundancy to tolerate temporary
1536
1729
  # Availability Zone (AZ) unavailability. You can only deploy a
1537
- # Multi-AZ file system in AWS Regions that have a minimum of three
1538
- # Availability Zones. Also supports HDD storage type
1730
+ # Multi-AZ file system in Amazon Web Services Regions that have a
1731
+ # minimum of three Availability Zones. Also supports HDD storage
1732
+ # type
1539
1733
  #
1540
1734
  # * `SINGLE_AZ_1` - (Default) Choose to deploy a file system that is
1541
1735
  # configured for single AZ redundancy.
@@ -1555,10 +1749,10 @@ module Aws::FSx
1555
1749
  # @!attribute [rw] preferred_subnet_id
1556
1750
  # Required when `DeploymentType` is set to `MULTI_AZ_1`. This
1557
1751
  # specifies the subnet in which you want the preferred file server to
1558
- # be located. For in-AWS applications, we recommend that you launch
1559
- # your clients in the same Availability Zone (AZ) as your preferred
1560
- # file server to reduce cross-AZ data transfer costs and minimize
1561
- # latency.
1752
+ # be located. For in-Amazon Web Services applications, we recommend
1753
+ # that you launch your clients in the same Availability Zone (AZ) as
1754
+ # your preferred file server to reduce cross-AZ data transfer costs
1755
+ # and minimize latency.
1562
1756
  # @return [String]
1563
1757
  #
1564
1758
  # @!attribute [rw] throughput_capacity
@@ -1659,137 +1853,520 @@ module Aws::FSx
1659
1853
  include Aws::Structure
1660
1854
  end
1661
1855
 
1662
- # The data repository configuration object for Lustre file systems
1663
- # returned in the response of the `CreateFileSystem` operation.
1664
- #
1665
- # @!attribute [rw] lifecycle
1666
- # Describes the state of the file system's S3 durable data
1667
- # repository, if it is configured with an S3 repository. The lifecycle
1668
- # can have the following values:
1856
+ # Specifies the configuration of the ONTAP volume that you are creating.
1669
1857
  #
1670
- # * `CREATING` - The data repository configuration between the FSx
1671
- # file system and the linked S3 data repository is being created.
1672
- # The data repository is unavailable.
1858
+ # @note When making an API call, you may pass CreateOntapVolumeConfiguration
1859
+ # data as a hash:
1673
1860
  #
1674
- # * `AVAILABLE` - The data repository is available for use.
1861
+ # {
1862
+ # junction_path: "JunctionPath", # required
1863
+ # security_style: "UNIX", # accepts UNIX, NTFS, MIXED
1864
+ # size_in_megabytes: 1, # required
1865
+ # storage_efficiency_enabled: false, # required
1866
+ # storage_virtual_machine_id: "StorageVirtualMachineId", # required
1867
+ # tiering_policy: {
1868
+ # cooling_period: 1,
1869
+ # name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
1870
+ # },
1871
+ # }
1675
1872
  #
1676
- # * `MISCONFIGURED` - Amazon FSx cannot automatically import updates
1677
- # from the S3 bucket until the data repository configuration is
1678
- # corrected. For more information, see [Troubleshooting a
1679
- # Misconfigured linked S3 bucket][1].
1873
+ # @!attribute [rw] junction_path
1874
+ # Specifies the location in the SVM's namespace where the volume is
1875
+ # mounted. The `JunctionPath` must have a leading forward slash, such
1876
+ # as `/vol3`.
1877
+ # @return [String]
1680
1878
  #
1681
- # * `UPDATING` - The data repository is undergoing a customer
1682
- # initiated update and availability may be impacted.
1879
+ # @!attribute [rw] security_style
1880
+ # The security style for the volume. Specify one of the following
1881
+ # values:
1683
1882
  #
1883
+ # * `UNIX` if the file system is managed by a UNIX administrator, the
1884
+ # majority of users are NFS clients, and an application accessing
1885
+ # the data uses a UNIX user as the service account. `UNIX` is the
1886
+ # default.
1684
1887
  #
1888
+ # * `NTFS` if the file system is managed by a Windows administrator,
1889
+ # the majority of users are SMB clients, and an application
1890
+ # accessing the data uses a Windows user as the service account.
1685
1891
  #
1686
- # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository
1892
+ # * `MIXED` if the file system is managed by both UNIX and Windows
1893
+ # administrators and users consist of both NFS and SMB clients.
1687
1894
  # @return [String]
1688
1895
  #
1689
- # @!attribute [rw] import_path
1690
- # The import path to the Amazon S3 bucket (and optional prefix) that
1691
- # you're using as the data repository for your FSx for Lustre file
1692
- # system, for example `s3://import-bucket/optional-prefix`. If a
1693
- # prefix is specified after the Amazon S3 bucket name, only object
1694
- # keys with that prefix are loaded into the file system.
1695
- # @return [String]
1896
+ # @!attribute [rw] size_in_megabytes
1897
+ # Specifies the size of the volume, in megabytes (MB), that you are
1898
+ # creating.
1899
+ # @return [Integer]
1696
1900
  #
1697
- # @!attribute [rw] export_path
1698
- # The export path to the Amazon S3 bucket (and prefix) that you are
1699
- # using to store new and changed Lustre file system files in S3.
1901
+ # @!attribute [rw] storage_efficiency_enabled
1902
+ # Set to true to enable deduplication, compression, and compaction
1903
+ # storage efficiency features on the volume.
1904
+ # @return [Boolean]
1905
+ #
1906
+ # @!attribute [rw] storage_virtual_machine_id
1907
+ # Specifies the ONTAP SVM in which to create the volume.
1700
1908
  # @return [String]
1701
1909
  #
1702
- # @!attribute [rw] imported_file_chunk_size
1703
- # For files imported from a data repository, this value determines the
1704
- # stripe count and maximum amount of data per file (in MiB) stored on
1705
- # a single physical disk. The maximum number of disks that a single
1706
- # file can be striped across is limited by the total number of disks
1707
- # that make up the file system.
1910
+ # @!attribute [rw] tiering_policy
1911
+ # Describes the data tiering policy for an ONTAP volume. When enabled,
1912
+ # Amazon FSx for ONTAP's intelligent tiering automatically
1913
+ # transitions a volume's data between the file system's primary
1914
+ # storage and capacity pool storage based on your access patterns.
1915
+ # @return [Types::TieringPolicy]
1708
1916
  #
1709
- # The default chunk size is 1,024 MiB (1 GiB) and can go as high as
1710
- # 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5
1711
- # TB.
1712
- # @return [Integer]
1917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOntapVolumeConfiguration AWS API Documentation
1713
1918
  #
1714
- # @!attribute [rw] auto_import_policy
1715
- # Describes the file system's linked S3 data repository's
1716
- # `AutoImportPolicy`. The AutoImportPolicy configures how Amazon FSx
1717
- # keeps your file and directory listings up to date as you add or
1718
- # modify objects in your linked S3 bucket. `AutoImportPolicy` can have
1719
- # the following values:
1919
+ class CreateOntapVolumeConfiguration < Struct.new(
1920
+ :junction_path,
1921
+ :security_style,
1922
+ :size_in_megabytes,
1923
+ :storage_efficiency_enabled,
1924
+ :storage_virtual_machine_id,
1925
+ :tiering_policy)
1926
+ SENSITIVE = []
1927
+ include Aws::Structure
1928
+ end
1929
+
1930
+ # @note When making an API call, you may pass CreateStorageVirtualMachineRequest
1931
+ # data as a hash:
1720
1932
  #
1721
- # * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file
1722
- # and directory listings from the linked S3 bucket when the file
1723
- # system is created. FSx does not update file and directory listings
1724
- # for any new or changed objects after choosing this option.
1933
+ # {
1934
+ # active_directory_configuration: {
1935
+ # net_bios_name: "NetBiosAlias", # required
1936
+ # self_managed_active_directory_configuration: {
1937
+ # domain_name: "ActiveDirectoryFullyQualifiedName", # required
1938
+ # organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
1939
+ # file_system_administrators_group: "FileSystemAdministratorsGroupName",
1940
+ # user_name: "DirectoryUserName", # required
1941
+ # password: "DirectoryPassword", # required
1942
+ # dns_ips: ["IpAddress"], # required
1943
+ # },
1944
+ # },
1945
+ # client_request_token: "ClientRequestToken",
1946
+ # file_system_id: "FileSystemId", # required
1947
+ # name: "StorageVirtualMachineName", # required
1948
+ # svm_admin_password: "AdminPassword",
1949
+ # tags: [
1950
+ # {
1951
+ # key: "TagKey", # required
1952
+ # value: "TagValue", # required
1953
+ # },
1954
+ # ],
1955
+ # root_volume_security_style: "UNIX", # accepts UNIX, NTFS, MIXED
1956
+ # }
1725
1957
  #
1726
- # * `NEW` - AutoImport is on. Amazon FSx automatically imports
1727
- # directory listings of any new objects added to the linked S3
1728
- # bucket that do not currently exist in the FSx file system.
1958
+ # @!attribute [rw] active_directory_configuration
1959
+ # Describes the self-managed Microsoft Active Directory to which you
1960
+ # want to join the SVM. Joining an Active Directory provides user
1961
+ # authentication and access control for SMB clients, including
1962
+ # Microsoft Windows and macOS client accessing the file system.
1963
+ # @return [Types::CreateSvmActiveDirectoryConfiguration]
1729
1964
  #
1730
- # * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports
1731
- # file and directory listings of any new objects added to the S3
1732
- # bucket and any existing objects that are changed in the S3 bucket
1733
- # after you choose this option.
1965
+ # @!attribute [rw] client_request_token
1966
+ # (Optional) An idempotency token for resource creation, in a string
1967
+ # of up to 64 ASCII characters. This token is automatically filled on
1968
+ # your behalf when you use the Command Line Interface (CLI) or an
1969
+ # Amazon Web Services SDK.
1734
1970
  #
1735
- # For more information, see [Automatically import updates from your S3
1736
- # bucket][1].
1971
+ # **A suitable default value is auto-generated.** You should normally
1972
+ # not need to pass this option.
1973
+ # @return [String]
1737
1974
  #
1975
+ # @!attribute [rw] file_system_id
1976
+ # The globally unique ID of the file system, assigned by Amazon FSx.
1977
+ # @return [String]
1738
1978
  #
1979
+ # @!attribute [rw] name
1980
+ # The name of the SVM.
1981
+ # @return [String]
1739
1982
  #
1740
- # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html
1983
+ # @!attribute [rw] svm_admin_password
1984
+ # The password to use when managing the SVM using the NetApp ONTAP CLI
1985
+ # or REST API. If you do not specify a password, you can still use the
1986
+ # file system's `fsxadmin` user to manage the SVM.
1741
1987
  # @return [String]
1742
1988
  #
1743
- # @!attribute [rw] failure_details
1744
- # Provides detailed information about the data respository if its
1745
- # `Lifecycle` is set to `MISCONFIGURED`.
1746
- # @return [Types::DataRepositoryFailureDetails]
1989
+ # @!attribute [rw] tags
1990
+ # A list of `Tag` values, with a maximum of 50 elements.
1991
+ # @return [Array<Types::Tag>]
1747
1992
  #
1748
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryConfiguration AWS API Documentation
1993
+ # @!attribute [rw] root_volume_security_style
1994
+ # The security style of the root volume of the SVM. Specify one of the
1995
+ # following values:
1749
1996
  #
1750
- class DataRepositoryConfiguration < Struct.new(
1751
- :lifecycle,
1752
- :import_path,
1753
- :export_path,
1754
- :imported_file_chunk_size,
1755
- :auto_import_policy,
1756
- :failure_details)
1757
- SENSITIVE = []
1758
- include Aws::Structure
1759
- end
1760
-
1761
- # Provides detailed information about the data respository if its
1762
- # `Lifecycle` is set to `MISCONFIGURED`.
1997
+ # * `UNIX` if the file system is managed by a UNIX administrator, the
1998
+ # majority of users are NFS clients, and an application accessing
1999
+ # the data uses a UNIX user as the service account.
1763
2000
  #
1764
- # @!attribute [rw] message
1765
- # A detailed error message.
2001
+ # * `NTFS` if the file system is managed by a Windows administrator,
2002
+ # the majority of users are SMB clients, and an application
2003
+ # accessing the data uses a Windows user as the service account.
2004
+ #
2005
+ # * `MIXED` if the file system is managed by both UNIX and Windows
2006
+ # administrators and users consist of both NFS and SMB clients.
1766
2007
  # @return [String]
1767
2008
  #
1768
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryFailureDetails AWS API Documentation
2009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateStorageVirtualMachineRequest AWS API Documentation
1769
2010
  #
1770
- class DataRepositoryFailureDetails < Struct.new(
1771
- :message)
1772
- SENSITIVE = []
2011
+ class CreateStorageVirtualMachineRequest < Struct.new(
2012
+ :active_directory_configuration,
2013
+ :client_request_token,
2014
+ :file_system_id,
2015
+ :name,
2016
+ :svm_admin_password,
2017
+ :tags,
2018
+ :root_volume_security_style)
2019
+ SENSITIVE = [:svm_admin_password]
1773
2020
  include Aws::Structure
1774
2021
  end
1775
2022
 
1776
- # A description of the data repository task. You use data repository
1777
- # tasks to perform bulk transfer operations between your Amazon FSx file
1778
- # system and its linked data repository.
1779
- #
1780
- # @!attribute [rw] task_id
1781
- # The system-generated, unique 17-digit ID of the data repository
1782
- # task.
1783
- # @return [String]
2023
+ # @!attribute [rw] storage_virtual_machine
2024
+ # Returned after a successful `CreateStorageVirtualMachine` operation;
2025
+ # describes the SVM just created.
2026
+ # @return [Types::StorageVirtualMachine]
1784
2027
  #
1785
- # @!attribute [rw] lifecycle
1786
- # The lifecycle status of the data repository task, as follows:
2028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateStorageVirtualMachineResponse AWS API Documentation
1787
2029
  #
1788
- # * `PENDING` - Amazon FSx has not started the task.
2030
+ class CreateStorageVirtualMachineResponse < Struct.new(
2031
+ :storage_virtual_machine)
2032
+ SENSITIVE = []
2033
+ include Aws::Structure
2034
+ end
2035
+
2036
+ # The configuration that Amazon FSx uses to join the ONTAP storage
2037
+ # virtual machine (SVM) to your self-managed (including on-premises)
2038
+ # Microsoft Active Directory (AD) directory.
1789
2039
  #
1790
- # * `EXECUTING` - Amazon FSx is processing the task.
2040
+ # @note When making an API call, you may pass CreateSvmActiveDirectoryConfiguration
2041
+ # data as a hash:
1791
2042
  #
1792
- # * `FAILED` - Amazon FSx was not able to complete the task. For
2043
+ # {
2044
+ # net_bios_name: "NetBiosAlias", # required
2045
+ # self_managed_active_directory_configuration: {
2046
+ # domain_name: "ActiveDirectoryFullyQualifiedName", # required
2047
+ # organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
2048
+ # file_system_administrators_group: "FileSystemAdministratorsGroupName",
2049
+ # user_name: "DirectoryUserName", # required
2050
+ # password: "DirectoryPassword", # required
2051
+ # dns_ips: ["IpAddress"], # required
2052
+ # },
2053
+ # }
2054
+ #
2055
+ # @!attribute [rw] net_bios_name
2056
+ # The NetBIOS name of the Active Directory computer object that will
2057
+ # be created for your SVM.
2058
+ # @return [String]
2059
+ #
2060
+ # @!attribute [rw] self_managed_active_directory_configuration
2061
+ # The configuration that Amazon FSx uses to join a FSx for Windows
2062
+ # File Server file system or an ONTAP storage virtual machine (SVM) to
2063
+ # a self-managed (including on-premises) Microsoft Active Directory
2064
+ # (AD) directory. For more information, see [ Using Amazon FSx with
2065
+ # your self-managed Microsoft Active Directory][1] or [Managing
2066
+ # SVMs][2].
2067
+ #
2068
+ #
2069
+ #
2070
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
2071
+ # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
2072
+ # @return [Types::SelfManagedActiveDirectoryConfiguration]
2073
+ #
2074
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateSvmActiveDirectoryConfiguration AWS API Documentation
2075
+ #
2076
+ class CreateSvmActiveDirectoryConfiguration < Struct.new(
2077
+ :net_bios_name,
2078
+ :self_managed_active_directory_configuration)
2079
+ SENSITIVE = []
2080
+ include Aws::Structure
2081
+ end
2082
+
2083
+ # @note When making an API call, you may pass CreateVolumeFromBackupRequest
2084
+ # data as a hash:
2085
+ #
2086
+ # {
2087
+ # backup_id: "BackupId", # required
2088
+ # client_request_token: "ClientRequestToken",
2089
+ # name: "VolumeName", # required
2090
+ # ontap_configuration: {
2091
+ # junction_path: "JunctionPath", # required
2092
+ # security_style: "UNIX", # accepts UNIX, NTFS, MIXED
2093
+ # size_in_megabytes: 1, # required
2094
+ # storage_efficiency_enabled: false, # required
2095
+ # storage_virtual_machine_id: "StorageVirtualMachineId", # required
2096
+ # tiering_policy: {
2097
+ # cooling_period: 1,
2098
+ # name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
2099
+ # },
2100
+ # },
2101
+ # tags: [
2102
+ # {
2103
+ # key: "TagKey", # required
2104
+ # value: "TagValue", # required
2105
+ # },
2106
+ # ],
2107
+ # }
2108
+ #
2109
+ # @!attribute [rw] backup_id
2110
+ # The ID of the source backup. Specifies the backup you are copying.
2111
+ # @return [String]
2112
+ #
2113
+ # @!attribute [rw] client_request_token
2114
+ # (Optional) An idempotency token for resource creation, in a string
2115
+ # of up to 64 ASCII characters. This token is automatically filled on
2116
+ # your behalf when you use the Command Line Interface (CLI) or an
2117
+ # Amazon Web Services SDK.
2118
+ #
2119
+ # **A suitable default value is auto-generated.** You should normally
2120
+ # not need to pass this option.
2121
+ # @return [String]
2122
+ #
2123
+ # @!attribute [rw] name
2124
+ # The name of the new volume you're creating.
2125
+ # @return [String]
2126
+ #
2127
+ # @!attribute [rw] ontap_configuration
2128
+ # Specifies the configuration of the ONTAP volume that you are
2129
+ # creating.
2130
+ # @return [Types::CreateOntapVolumeConfiguration]
2131
+ #
2132
+ # @!attribute [rw] tags
2133
+ # A list of `Tag` values, with a maximum of 50 elements.
2134
+ # @return [Array<Types::Tag>]
2135
+ #
2136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeFromBackupRequest AWS API Documentation
2137
+ #
2138
+ class CreateVolumeFromBackupRequest < Struct.new(
2139
+ :backup_id,
2140
+ :client_request_token,
2141
+ :name,
2142
+ :ontap_configuration,
2143
+ :tags)
2144
+ SENSITIVE = []
2145
+ include Aws::Structure
2146
+ end
2147
+
2148
+ # @!attribute [rw] volume
2149
+ # Returned after a successful `CreateVolumeFromBackup` API operation,
2150
+ # describing the volume just created.
2151
+ # @return [Types::Volume]
2152
+ #
2153
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeFromBackupResponse AWS API Documentation
2154
+ #
2155
+ class CreateVolumeFromBackupResponse < Struct.new(
2156
+ :volume)
2157
+ SENSITIVE = []
2158
+ include Aws::Structure
2159
+ end
2160
+
2161
+ # @note When making an API call, you may pass CreateVolumeRequest
2162
+ # data as a hash:
2163
+ #
2164
+ # {
2165
+ # client_request_token: "ClientRequestToken",
2166
+ # volume_type: "ONTAP", # required, accepts ONTAP
2167
+ # name: "VolumeName", # required
2168
+ # ontap_configuration: {
2169
+ # junction_path: "JunctionPath", # required
2170
+ # security_style: "UNIX", # accepts UNIX, NTFS, MIXED
2171
+ # size_in_megabytes: 1, # required
2172
+ # storage_efficiency_enabled: false, # required
2173
+ # storage_virtual_machine_id: "StorageVirtualMachineId", # required
2174
+ # tiering_policy: {
2175
+ # cooling_period: 1,
2176
+ # name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
2177
+ # },
2178
+ # },
2179
+ # tags: [
2180
+ # {
2181
+ # key: "TagKey", # required
2182
+ # value: "TagValue", # required
2183
+ # },
2184
+ # ],
2185
+ # }
2186
+ #
2187
+ # @!attribute [rw] client_request_token
2188
+ # (Optional) An idempotency token for resource creation, in a string
2189
+ # of up to 64 ASCII characters. This token is automatically filled on
2190
+ # your behalf when you use the Command Line Interface (CLI) or an
2191
+ # Amazon Web Services SDK.
2192
+ #
2193
+ # **A suitable default value is auto-generated.** You should normally
2194
+ # not need to pass this option.
2195
+ # @return [String]
2196
+ #
2197
+ # @!attribute [rw] volume_type
2198
+ # Specifies the type of volume to create; `ONTAP` is the only valid
2199
+ # volume type.
2200
+ # @return [String]
2201
+ #
2202
+ # @!attribute [rw] name
2203
+ # Specifies the name of the volume you're creating.
2204
+ # @return [String]
2205
+ #
2206
+ # @!attribute [rw] ontap_configuration
2207
+ # Specifies the `ONTAP` configuration to use in creating the volume.
2208
+ # @return [Types::CreateOntapVolumeConfiguration]
2209
+ #
2210
+ # @!attribute [rw] tags
2211
+ # A list of `Tag` values, with a maximum of 50 elements.
2212
+ # @return [Array<Types::Tag>]
2213
+ #
2214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeRequest AWS API Documentation
2215
+ #
2216
+ class CreateVolumeRequest < Struct.new(
2217
+ :client_request_token,
2218
+ :volume_type,
2219
+ :name,
2220
+ :ontap_configuration,
2221
+ :tags)
2222
+ SENSITIVE = []
2223
+ include Aws::Structure
2224
+ end
2225
+
2226
+ # @!attribute [rw] volume
2227
+ # Returned after a successful `CreateVolume` API operation, describing
2228
+ # the volume just created.
2229
+ # @return [Types::Volume]
2230
+ #
2231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeResponse AWS API Documentation
2232
+ #
2233
+ class CreateVolumeResponse < Struct.new(
2234
+ :volume)
2235
+ SENSITIVE = []
2236
+ include Aws::Structure
2237
+ end
2238
+
2239
+ # The data repository configuration object for Lustre file systems
2240
+ # returned in the response of the `CreateFileSystem` operation.
2241
+ #
2242
+ # @!attribute [rw] lifecycle
2243
+ # Describes the state of the file system's S3 durable data
2244
+ # repository, if it is configured with an S3 repository. The lifecycle
2245
+ # can have the following values:
2246
+ #
2247
+ # * `CREATING` - The data repository configuration between the FSx
2248
+ # file system and the linked S3 data repository is being created.
2249
+ # The data repository is unavailable.
2250
+ #
2251
+ # * `AVAILABLE` - The data repository is available for use.
2252
+ #
2253
+ # * `MISCONFIGURED` - Amazon FSx cannot automatically import updates
2254
+ # from the S3 bucket until the data repository configuration is
2255
+ # corrected. For more information, see [Troubleshooting a
2256
+ # Misconfigured linked S3 bucket][1].
2257
+ #
2258
+ # * `UPDATING` - The data repository is undergoing a customer
2259
+ # initiated update and availability may be impacted.
2260
+ #
2261
+ #
2262
+ #
2263
+ # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository
2264
+ # @return [String]
2265
+ #
2266
+ # @!attribute [rw] import_path
2267
+ # The import path to the Amazon S3 bucket (and optional prefix) that
2268
+ # you're using as the data repository for your FSx for Lustre file
2269
+ # system, for example `s3://import-bucket/optional-prefix`. If a
2270
+ # prefix is specified after the Amazon S3 bucket name, only object
2271
+ # keys with that prefix are loaded into the file system.
2272
+ # @return [String]
2273
+ #
2274
+ # @!attribute [rw] export_path
2275
+ # The export path to the Amazon S3 bucket (and prefix) that you are
2276
+ # using to store new and changed Lustre file system files in S3.
2277
+ # @return [String]
2278
+ #
2279
+ # @!attribute [rw] imported_file_chunk_size
2280
+ # For files imported from a data repository, this value determines the
2281
+ # stripe count and maximum amount of data per file (in MiB) stored on
2282
+ # a single physical disk. The maximum number of disks that a single
2283
+ # file can be striped across is limited by the total number of disks
2284
+ # that make up the file system.
2285
+ #
2286
+ # The default chunk size is 1,024 MiB (1 GiB) and can go as high as
2287
+ # 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5
2288
+ # TB.
2289
+ # @return [Integer]
2290
+ #
2291
+ # @!attribute [rw] auto_import_policy
2292
+ # Describes the file system's linked S3 data repository's
2293
+ # `AutoImportPolicy`. The AutoImportPolicy configures how Amazon FSx
2294
+ # keeps your file and directory listings up to date as you add or
2295
+ # modify objects in your linked S3 bucket. `AutoImportPolicy` can have
2296
+ # the following values:
2297
+ #
2298
+ # * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file
2299
+ # and directory listings from the linked S3 bucket when the file
2300
+ # system is created. FSx does not update file and directory listings
2301
+ # for any new or changed objects after choosing this option.
2302
+ #
2303
+ # * `NEW` - AutoImport is on. Amazon FSx automatically imports
2304
+ # directory listings of any new objects added to the linked S3
2305
+ # bucket that do not currently exist in the FSx file system.
2306
+ #
2307
+ # * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports
2308
+ # file and directory listings of any new objects added to the S3
2309
+ # bucket and any existing objects that are changed in the S3 bucket
2310
+ # after you choose this option.
2311
+ #
2312
+ # For more information, see [Automatically import updates from your S3
2313
+ # bucket][1].
2314
+ #
2315
+ #
2316
+ #
2317
+ # [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html
2318
+ # @return [String]
2319
+ #
2320
+ # @!attribute [rw] failure_details
2321
+ # Provides detailed information about the data respository if its
2322
+ # `Lifecycle` is set to `MISCONFIGURED`.
2323
+ # @return [Types::DataRepositoryFailureDetails]
2324
+ #
2325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryConfiguration AWS API Documentation
2326
+ #
2327
+ class DataRepositoryConfiguration < Struct.new(
2328
+ :lifecycle,
2329
+ :import_path,
2330
+ :export_path,
2331
+ :imported_file_chunk_size,
2332
+ :auto_import_policy,
2333
+ :failure_details)
2334
+ SENSITIVE = []
2335
+ include Aws::Structure
2336
+ end
2337
+
2338
+ # Provides detailed information about the data respository if its
2339
+ # `Lifecycle` is set to `MISCONFIGURED`.
2340
+ #
2341
+ # @!attribute [rw] message
2342
+ # A detailed error message.
2343
+ # @return [String]
2344
+ #
2345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryFailureDetails AWS API Documentation
2346
+ #
2347
+ class DataRepositoryFailureDetails < Struct.new(
2348
+ :message)
2349
+ SENSITIVE = []
2350
+ include Aws::Structure
2351
+ end
2352
+
2353
+ # A description of the data repository task. You use data repository
2354
+ # tasks to perform bulk transfer operations between your Amazon FSx file
2355
+ # system and its linked data repository.
2356
+ #
2357
+ # @!attribute [rw] task_id
2358
+ # The system-generated, unique 17-digit ID of the data repository
2359
+ # task.
2360
+ # @return [String]
2361
+ #
2362
+ # @!attribute [rw] lifecycle
2363
+ # The lifecycle status of the data repository task, as follows:
2364
+ #
2365
+ # * `PENDING` - Amazon FSx has not started the task.
2366
+ #
2367
+ # * `EXECUTING` - Amazon FSx is processing the task.
2368
+ #
2369
+ # * `FAILED` - Amazon FSx was not able to complete the task. For
1793
2370
  # example, there may be files the task failed to process. The
1794
2371
  # DataRepositoryTaskFailureDetails property provides more
1795
2372
  # information about task failures.
@@ -1832,10 +2409,10 @@ module Aws::FSx
1832
2409
  #
1833
2410
  # @!attribute [rw] resource_arn
1834
2411
  # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
1835
- # identify AWS resources. We require an ARN when you need to specify a
1836
- # resource unambiguously across all of AWS. For more information, see
1837
- # [Amazon Resource Names (ARNs) and AWS Service Namespaces][1] in the
1838
- # *AWS General Reference*.
2412
+ # identify Amazon Web Services resources. We require an ARN when you
2413
+ # need to specify a resource unambiguously across all of Amazon Web
2414
+ # Services. For more information, see [Amazon Resource Names
2415
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
1839
2416
  #
1840
2417
  #
1841
2418
  #
@@ -2052,7 +2629,7 @@ module Aws::FSx
2052
2629
  # @!attribute [rw] client_request_token
2053
2630
  # A string of up to 64 ASCII characters that Amazon FSx uses to ensure
2054
2631
  # idempotent deletion. This is automatically filled on your behalf
2055
- # when using the AWS CLI or SDK.
2632
+ # when using the CLI or SDK.
2056
2633
  #
2057
2634
  # **A suitable default value is auto-generated.** You should normally
2058
2635
  # not need to pass this option.
@@ -2181,7 +2758,8 @@ module Aws::FSx
2181
2758
  # @!attribute [rw] client_request_token
2182
2759
  # A string of up to 64 ASCII characters that Amazon FSx uses to ensure
2183
2760
  # idempotent deletion. This is automatically filled on your behalf
2184
- # when using the AWS CLI or SDK.
2761
+ # when using the Command Line Interface (CLI) or an Amazon Web
2762
+ # Services SDK.
2185
2763
  #
2186
2764
  # **A suitable default value is auto-generated.** You should normally
2187
2765
  # not need to pass this option.
@@ -2297,16 +2875,187 @@ module Aws::FSx
2297
2875
  include Aws::Structure
2298
2876
  end
2299
2877
 
2300
- # The request object for `DescribeBackups` operation.
2301
- #
2302
- # @note When making an API call, you may pass DescribeBackupsRequest
2878
+ # @note When making an API call, you may pass DeleteStorageVirtualMachineRequest
2303
2879
  # data as a hash:
2304
2880
  #
2305
2881
  # {
2306
- # backup_ids: ["BackupId"],
2882
+ # client_request_token: "ClientRequestToken",
2883
+ # storage_virtual_machine_id: "StorageVirtualMachineId", # required
2884
+ # }
2885
+ #
2886
+ # @!attribute [rw] client_request_token
2887
+ # (Optional) An idempotency token for resource creation, in a string
2888
+ # of up to 64 ASCII characters. This token is automatically filled on
2889
+ # your behalf when you use the Command Line Interface (CLI) or an
2890
+ # Amazon Web Services SDK.
2891
+ #
2892
+ # **A suitable default value is auto-generated.** You should normally
2893
+ # not need to pass this option.
2894
+ # @return [String]
2895
+ #
2896
+ # @!attribute [rw] storage_virtual_machine_id
2897
+ # The ID of the SVM that you want to delete.
2898
+ # @return [String]
2899
+ #
2900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteStorageVirtualMachineRequest AWS API Documentation
2901
+ #
2902
+ class DeleteStorageVirtualMachineRequest < Struct.new(
2903
+ :client_request_token,
2904
+ :storage_virtual_machine_id)
2905
+ SENSITIVE = []
2906
+ include Aws::Structure
2907
+ end
2908
+
2909
+ # @!attribute [rw] storage_virtual_machine_id
2910
+ # The ID of the SVM Amazon FSx is deleting.
2911
+ # @return [String]
2912
+ #
2913
+ # @!attribute [rw] lifecycle
2914
+ # Describes the lifecycle state of the SVM being deleted.
2915
+ # @return [String]
2916
+ #
2917
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteStorageVirtualMachineResponse AWS API Documentation
2918
+ #
2919
+ class DeleteStorageVirtualMachineResponse < Struct.new(
2920
+ :storage_virtual_machine_id,
2921
+ :lifecycle)
2922
+ SENSITIVE = []
2923
+ include Aws::Structure
2924
+ end
2925
+
2926
+ # Use to specify skipping a final backup, or to add tags to a final
2927
+ # backup.
2928
+ #
2929
+ # @note When making an API call, you may pass DeleteVolumeOntapConfiguration
2930
+ # data as a hash:
2931
+ #
2932
+ # {
2933
+ # skip_final_backup: false,
2934
+ # final_backup_tags: [
2935
+ # {
2936
+ # key: "TagKey", # required
2937
+ # value: "TagValue", # required
2938
+ # },
2939
+ # ],
2940
+ # }
2941
+ #
2942
+ # @!attribute [rw] skip_final_backup
2943
+ # Set to true if you want to skip taking a final backup of the volume
2944
+ # you are deleting.
2945
+ # @return [Boolean]
2946
+ #
2947
+ # @!attribute [rw] final_backup_tags
2948
+ # A list of `Tag` values, with a maximum of 50 elements.
2949
+ # @return [Array<Types::Tag>]
2950
+ #
2951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOntapConfiguration AWS API Documentation
2952
+ #
2953
+ class DeleteVolumeOntapConfiguration < Struct.new(
2954
+ :skip_final_backup,
2955
+ :final_backup_tags)
2956
+ SENSITIVE = []
2957
+ include Aws::Structure
2958
+ end
2959
+
2960
+ # The response object for the Amazon FSx for NetApp ONTAP volume being
2961
+ # deleted in the `DeleteVolume` operation.
2962
+ #
2963
+ # @!attribute [rw] final_backup_id
2964
+ # The ID of the source backup. Specifies the backup you are copying.
2965
+ # @return [String]
2966
+ #
2967
+ # @!attribute [rw] final_backup_tags
2968
+ # A list of `Tag` values, with a maximum of 50 elements.
2969
+ # @return [Array<Types::Tag>]
2970
+ #
2971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOntapResponse AWS API Documentation
2972
+ #
2973
+ class DeleteVolumeOntapResponse < Struct.new(
2974
+ :final_backup_id,
2975
+ :final_backup_tags)
2976
+ SENSITIVE = []
2977
+ include Aws::Structure
2978
+ end
2979
+
2980
+ # @note When making an API call, you may pass DeleteVolumeRequest
2981
+ # data as a hash:
2982
+ #
2983
+ # {
2984
+ # client_request_token: "ClientRequestToken",
2985
+ # volume_id: "VolumeId", # required
2986
+ # ontap_configuration: {
2987
+ # skip_final_backup: false,
2988
+ # final_backup_tags: [
2989
+ # {
2990
+ # key: "TagKey", # required
2991
+ # value: "TagValue", # required
2992
+ # },
2993
+ # ],
2994
+ # },
2995
+ # }
2996
+ #
2997
+ # @!attribute [rw] client_request_token
2998
+ # (Optional) An idempotency token for resource creation, in a string
2999
+ # of up to 64 ASCII characters. This token is automatically filled on
3000
+ # your behalf when you use the Command Line Interface (CLI) or an
3001
+ # Amazon Web Services SDK.
3002
+ #
3003
+ # **A suitable default value is auto-generated.** You should normally
3004
+ # not need to pass this option.
3005
+ # @return [String]
3006
+ #
3007
+ # @!attribute [rw] volume_id
3008
+ # The ID of the volume you are deleting.
3009
+ # @return [String]
3010
+ #
3011
+ # @!attribute [rw] ontap_configuration
3012
+ # For Amazon FSx for ONTAP volumes, specify whether to take a final
3013
+ # backup of the volume, and apply tags to the backup.
3014
+ # @return [Types::DeleteVolumeOntapConfiguration]
3015
+ #
3016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeRequest AWS API Documentation
3017
+ #
3018
+ class DeleteVolumeRequest < Struct.new(
3019
+ :client_request_token,
3020
+ :volume_id,
3021
+ :ontap_configuration)
3022
+ SENSITIVE = []
3023
+ include Aws::Structure
3024
+ end
3025
+
3026
+ # @!attribute [rw] volume_id
3027
+ # The ID of the volume being deleted.
3028
+ # @return [String]
3029
+ #
3030
+ # @!attribute [rw] lifecycle
3031
+ # Describes the lifecycle state of the volume being deleted.
3032
+ # @return [String]
3033
+ #
3034
+ # @!attribute [rw] ontap_response
3035
+ # Returned after a `DeleteVolume request, showing the status of the
3036
+ # delete request.`
3037
+ # @return [Types::DeleteVolumeOntapResponse]
3038
+ #
3039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeResponse AWS API Documentation
3040
+ #
3041
+ class DeleteVolumeResponse < Struct.new(
3042
+ :volume_id,
3043
+ :lifecycle,
3044
+ :ontap_response)
3045
+ SENSITIVE = []
3046
+ include Aws::Structure
3047
+ end
3048
+
3049
+ # The request object for `DescribeBackups` operation.
3050
+ #
3051
+ # @note When making an API call, you may pass DescribeBackupsRequest
3052
+ # data as a hash:
3053
+ #
3054
+ # {
3055
+ # backup_ids: ["BackupId"],
2307
3056
  # filters: [
2308
3057
  # {
2309
- # name: "file-system-id", # accepts file-system-id, backup-type, file-system-type
3058
+ # name: "file-system-id", # accepts file-system-id, backup-type, file-system-type, volume-id
2310
3059
  # values: ["FilterValue"],
2311
3060
  # },
2312
3061
  # ],
@@ -2320,8 +3069,8 @@ module Aws::FSx
2320
3069
  # @return [Array<String>]
2321
3070
  #
2322
3071
  # @!attribute [rw] filters
2323
- # Filters structure. Supported names are file-system-id and
2324
- # backup-type.
3072
+ # Filters structure. Supported names are `file-system-id`,
3073
+ # `backup-type`, `file-system-type`, and `volume-id`.
2325
3074
  # @return [Array<Types::Filter>]
2326
3075
  #
2327
3076
  # @!attribute [rw] max_results
@@ -2454,8 +3203,8 @@ module Aws::FSx
2454
3203
  # @!attribute [rw] client_request_token
2455
3204
  # (Optional) An idempotency token for resource creation, in a string
2456
3205
  # of up to 64 ASCII characters. This token is automatically filled on
2457
- # your behalf when you use the AWS Command Line Interface (AWS CLI) or
2458
- # an AWS SDK.
3206
+ # your behalf when you use the Command Line Interface (CLI) or an
3207
+ # Amazon Web Services SDK.
2459
3208
  #
2460
3209
  # **A suitable default value is auto-generated.** You should normally
2461
3210
  # not need to pass this option.
@@ -2575,6 +3324,140 @@ module Aws::FSx
2575
3324
  include Aws::Structure
2576
3325
  end
2577
3326
 
3327
+ # @note When making an API call, you may pass DescribeStorageVirtualMachinesRequest
3328
+ # data as a hash:
3329
+ #
3330
+ # {
3331
+ # storage_virtual_machine_ids: ["StorageVirtualMachineId"],
3332
+ # filters: [
3333
+ # {
3334
+ # name: "file-system-id", # accepts file-system-id
3335
+ # values: ["StorageVirtualMachineFilterValue"],
3336
+ # },
3337
+ # ],
3338
+ # max_results: 1,
3339
+ # next_token: "NextToken",
3340
+ # }
3341
+ #
3342
+ # @!attribute [rw] storage_virtual_machine_ids
3343
+ # Enter the ID of one or more SVMs that you want to view.
3344
+ # @return [Array<String>]
3345
+ #
3346
+ # @!attribute [rw] filters
3347
+ # Enter a filter name:value pair to view a select set of SVMs.
3348
+ # @return [Array<Types::StorageVirtualMachineFilter>]
3349
+ #
3350
+ # @!attribute [rw] max_results
3351
+ # The maximum number of resources to return in the response. This
3352
+ # value must be an integer greater than zero.
3353
+ # @return [Integer]
3354
+ #
3355
+ # @!attribute [rw] next_token
3356
+ # (Optional) Opaque pagination token returned from a previous
3357
+ # operation (String). If present, this token indicates from what point
3358
+ # you can continue processing the request, where the previous
3359
+ # `NextToken` value left off.
3360
+ # @return [String]
3361
+ #
3362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeStorageVirtualMachinesRequest AWS API Documentation
3363
+ #
3364
+ class DescribeStorageVirtualMachinesRequest < Struct.new(
3365
+ :storage_virtual_machine_ids,
3366
+ :filters,
3367
+ :max_results,
3368
+ :next_token)
3369
+ SENSITIVE = []
3370
+ include Aws::Structure
3371
+ end
3372
+
3373
+ # @!attribute [rw] storage_virtual_machines
3374
+ # Returned after a successful `DescribeStorageVirtualMachines`
3375
+ # operation, describing each SVM.
3376
+ # @return [Array<Types::StorageVirtualMachine>]
3377
+ #
3378
+ # @!attribute [rw] next_token
3379
+ # (Optional) Opaque pagination token returned from a previous
3380
+ # operation (String). If present, this token indicates from what point
3381
+ # you can continue processing the request, where the previous
3382
+ # `NextToken` value left off.
3383
+ # @return [String]
3384
+ #
3385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeStorageVirtualMachinesResponse AWS API Documentation
3386
+ #
3387
+ class DescribeStorageVirtualMachinesResponse < Struct.new(
3388
+ :storage_virtual_machines,
3389
+ :next_token)
3390
+ SENSITIVE = []
3391
+ include Aws::Structure
3392
+ end
3393
+
3394
+ # @note When making an API call, you may pass DescribeVolumesRequest
3395
+ # data as a hash:
3396
+ #
3397
+ # {
3398
+ # volume_ids: ["VolumeId"],
3399
+ # filters: [
3400
+ # {
3401
+ # name: "file-system-id", # accepts file-system-id, storage-virtual-machine-id
3402
+ # values: ["VolumeFilterValue"],
3403
+ # },
3404
+ # ],
3405
+ # max_results: 1,
3406
+ # next_token: "NextToken",
3407
+ # }
3408
+ #
3409
+ # @!attribute [rw] volume_ids
3410
+ # IDs of the volumes whose descriptions you want to retrieve.
3411
+ # @return [Array<String>]
3412
+ #
3413
+ # @!attribute [rw] filters
3414
+ # Enter a filter name:value pair to view a select set of volumes.
3415
+ # @return [Array<Types::VolumeFilter>]
3416
+ #
3417
+ # @!attribute [rw] max_results
3418
+ # The maximum number of resources to return in the response. This
3419
+ # value must be an integer greater than zero.
3420
+ # @return [Integer]
3421
+ #
3422
+ # @!attribute [rw] next_token
3423
+ # (Optional) Opaque pagination token returned from a previous
3424
+ # operation (String). If present, this token indicates from what point
3425
+ # you can continue processing the request, where the previous
3426
+ # `NextToken` value left off.
3427
+ # @return [String]
3428
+ #
3429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumesRequest AWS API Documentation
3430
+ #
3431
+ class DescribeVolumesRequest < Struct.new(
3432
+ :volume_ids,
3433
+ :filters,
3434
+ :max_results,
3435
+ :next_token)
3436
+ SENSITIVE = []
3437
+ include Aws::Structure
3438
+ end
3439
+
3440
+ # @!attribute [rw] volumes
3441
+ # Returned after a successful `DescribeVolumes` operation, describing
3442
+ # each volume.
3443
+ # @return [Array<Types::Volume>]
3444
+ #
3445
+ # @!attribute [rw] next_token
3446
+ # (Optional) Opaque pagination token returned from a previous
3447
+ # operation (String). If present, this token indicates from what point
3448
+ # you can continue processing the request, where the previous
3449
+ # `NextToken` value left off.
3450
+ # @return [String]
3451
+ #
3452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumesResponse AWS API Documentation
3453
+ #
3454
+ class DescribeVolumesResponse < Struct.new(
3455
+ :volumes,
3456
+ :next_token)
3457
+ SENSITIVE = []
3458
+ include Aws::Structure
3459
+ end
3460
+
2578
3461
  # The request object of DNS aliases to disassociate from an Amazon FSx
2579
3462
  # for Windows File Server file system.
2580
3463
  #
@@ -2590,8 +3473,8 @@ module Aws::FSx
2590
3473
  # @!attribute [rw] client_request_token
2591
3474
  # (Optional) An idempotency token for resource creation, in a string
2592
3475
  # of up to 64 ASCII characters. This token is automatically filled on
2593
- # your behalf when you use the AWS Command Line Interface (AWS CLI) or
2594
- # an AWS SDK.
3476
+ # your behalf when you use the Command Line Interface (CLI) or an
3477
+ # Amazon Web Services SDK.
2595
3478
  #
2596
3479
  # **A suitable default value is auto-generated.** You should normally
2597
3480
  # not need to pass this option.
@@ -2635,12 +3518,47 @@ module Aws::FSx
2635
3518
  include Aws::Structure
2636
3519
  end
2637
3520
 
3521
+ # The SSD IOPS (input/output operations per second) configuration for an
3522
+ # Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB
3523
+ # of storage capacity, but you can provision additional IOPS per GB of
3524
+ # storage. The configuration consists of the total number of provisioned
3525
+ # SSD IOPS and how the amount was provisioned (by the customer or by the
3526
+ # system).
3527
+ #
3528
+ # @note When making an API call, you may pass DiskIopsConfiguration
3529
+ # data as a hash:
3530
+ #
3531
+ # {
3532
+ # mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
3533
+ # iops: 1,
3534
+ # }
3535
+ #
3536
+ # @!attribute [rw] mode
3537
+ # Specifies whether the number of IOPS for the file system is using
3538
+ # the system default (`AUTOMATIC`) or was provisioned by the customer
3539
+ # (`USER_PROVISIONED`).
3540
+ # @return [String]
3541
+ #
3542
+ # @!attribute [rw] iops
3543
+ # The total number of SSD IOPS provisioned for the file system.
3544
+ # @return [Integer]
3545
+ #
3546
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DiskIopsConfiguration AWS API Documentation
3547
+ #
3548
+ class DiskIopsConfiguration < Struct.new(
3549
+ :mode,
3550
+ :iops)
3551
+ SENSITIVE = []
3552
+ include Aws::Structure
3553
+ end
3554
+
2638
3555
  # A description of a specific Amazon FSx file system.
2639
3556
  #
2640
3557
  # @!attribute [rw] owner_id
2641
- # The AWS account that created the file system. If the file system was
2642
- # created by an AWS Identity and Access Management (IAM) user, the AWS
2643
- # account to which the IAM user belongs is the owner.
3558
+ # The Amazon Web Services account that created the file system. If the
3559
+ # file system was created by an Identity and Access Management (IAM)
3560
+ # user, the Amazon Web Services account to which the IAM user belongs
3561
+ # is the owner.
2644
3562
  # @return [String]
2645
3563
  #
2646
3564
  # @!attribute [rw] creation_time
@@ -2653,7 +3571,8 @@ module Aws::FSx
2653
3571
  # @return [String]
2654
3572
  #
2655
3573
  # @!attribute [rw] file_system_type
2656
- # The type of Amazon FSx file system, either `LUSTRE` or `WINDOWS`.
3574
+ # The type of Amazon FSx file system, which can be `LUSTRE`,
3575
+ # `WINDOWS`, or `ONTAP`.
2657
3576
  # @return [String]
2658
3577
  #
2659
3578
  # @!attribute [rw] lifecycle
@@ -2700,16 +3619,16 @@ module Aws::FSx
2700
3619
  #
2701
3620
  # @!attribute [rw] subnet_ids
2702
3621
  # Specifies the IDs of the subnets that the file system is accessible
2703
- # from. For Windows `MULTI_AZ_1` file system deployment type, there
2704
- # are two subnet IDs, one for the preferred file server and one for
2705
- # the standby file server. The preferred file server subnet identified
2706
- # in the `PreferredSubnetID` property. All other file systems have
2707
- # only one subnet ID.
3622
+ # from. For Windows and ONTAP `MULTI_AZ_1` file system deployment
3623
+ # type, there are two subnet IDs, one for the preferred file server
3624
+ # and one for the standby file server. The preferred file server
3625
+ # subnet identified in the `PreferredSubnetID` property. All other
3626
+ # file systems have only one subnet ID.
2708
3627
  #
2709
3628
  # For Lustre file systems, and Single-AZ Windows file systems, this is
2710
3629
  # the ID of the subnet that contains the endpoint for the file system.
2711
- # For `MULTI_AZ_1` Windows file systems, the endpoint for the file
2712
- # system is available in the `PreferredSubnetID`.
3630
+ # For `MULTI_AZ_1` Windows and ONTAP file systems, the endpoint for
3631
+ # the file system is available in the `PreferredSubnetID`.
2713
3632
  # @return [Array<String>]
2714
3633
  #
2715
3634
  # @!attribute [rw] network_interface_ids
@@ -2733,14 +3652,14 @@ module Aws::FSx
2733
3652
  # @return [String]
2734
3653
  #
2735
3654
  # @!attribute [rw] kms_key_id
2736
- # The ID of the AWS Key Management Service (AWS KMS) key used to
2737
- # encrypt the file system's data for Amazon FSx for Windows File
2738
- # Server file systems and persistent Amazon FSx for Lustre file
2739
- # systems at rest. In either case, if not specified, the Amazon FSx
2740
- # managed key is used. The scratch Amazon FSx for Lustre file systems
2741
- # are always encrypted at rest using Amazon FSx managed keys. For more
2742
- # information, see [Encrypt][1] in the *AWS Key Management Service API
2743
- # Reference*.
3655
+ # The ID of the Key Management Service (KMS) key used to encrypt the
3656
+ # file system's data for Amazon FSx for Windows File Server file
3657
+ # systems, Amazon FSx for NetApp ONTAP file systems, and persistent
3658
+ # Amazon FSx for Lustre file systems at rest. If not specified, the
3659
+ # Amazon FSx managed key is used. The scratch Amazon FSx for Lustre
3660
+ # file systems are always encrypted at rest using Amazon FSx managed
3661
+ # keys. For more information, see [Encrypt][1] in the *Key Management
3662
+ # Service API Reference*.
2744
3663
  #
2745
3664
  #
2746
3665
  #
@@ -2772,10 +3691,19 @@ module Aws::FSx
2772
3691
  # @!attribute [rw] administrative_actions
2773
3692
  # A list of administrative actions for the file system that are in
2774
3693
  # process or waiting to be processed. Administrative actions describe
2775
- # changes to the Windows file system that you have initiated using the
2776
- # `UpdateFileSystem` action.
3694
+ # changes to the Amazon FSx file system that you have initiated using
3695
+ # the `UpdateFileSystem` action.
2777
3696
  # @return [Array<Types::AdministrativeAction>]
2778
3697
  #
3698
+ # @!attribute [rw] ontap_configuration
3699
+ # The configuration for this FSx for NetApp ONTAP file system.
3700
+ # @return [Types::OntapFileSystemConfiguration]
3701
+ #
3702
+ # @!attribute [rw] file_system_type_version
3703
+ # The version of your Amazon FSx for Lustre file system, either `2.10`
3704
+ # or `2.12`.
3705
+ # @return [String]
3706
+ #
2779
3707
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystem AWS API Documentation
2780
3708
  #
2781
3709
  class FileSystem < Struct.new(
@@ -2796,36 +3724,84 @@ module Aws::FSx
2796
3724
  :tags,
2797
3725
  :windows_configuration,
2798
3726
  :lustre_configuration,
2799
- :administrative_actions)
3727
+ :administrative_actions,
3728
+ :ontap_configuration,
3729
+ :file_system_type_version)
2800
3730
  SENSITIVE = []
2801
3731
  include Aws::Structure
2802
3732
  end
2803
3733
 
2804
- # A structure providing details of any failures that occur when creating
2805
- # the file system has failed.
3734
+ # An Amazon FSx for NetApp ONTAP file system has two endpoints that are
3735
+ # used to access data or to manage the file system using the NetApp
3736
+ # ONTAP CLI, REST API, or NetApp SnapMirror. They are the `Management`
3737
+ # and `Intercluster` endpoints.
2806
3738
  #
2807
- # @!attribute [rw] message
2808
- # A message describing any failures that occurred during file system
2809
- # creation.
3739
+ # @!attribute [rw] dns_name
3740
+ # The Domain Name Service (DNS) name for the file system. You can
3741
+ # mount your file system using its DNS name.
2810
3742
  # @return [String]
2811
3743
  #
2812
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemFailureDetails AWS API Documentation
3744
+ # @!attribute [rw] ip_addresses
3745
+ # IP addresses of the file system endpoint.
3746
+ # @return [Array<String>]
2813
3747
  #
2814
- class FileSystemFailureDetails < Struct.new(
2815
- :message)
3748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemEndpoint AWS API Documentation
3749
+ #
3750
+ class FileSystemEndpoint < Struct.new(
3751
+ :dns_name,
3752
+ :ip_addresses)
2816
3753
  SENSITIVE = []
2817
3754
  include Aws::Structure
2818
3755
  end
2819
3756
 
2820
- # No Amazon FSx file systems were found based upon supplied parameters.
3757
+ # An Amazon FSx for NetApp ONTAP file system has the following endpoints
3758
+ # that are used to access data or to manage the file system using the
3759
+ # NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
2821
3760
  #
2822
- # @!attribute [rw] message
2823
- # A detailed error message.
2824
- # @return [String]
3761
+ # @!attribute [rw] intercluster
3762
+ # An endpoint for managing your file system by setting up NetApp
3763
+ # SnapMirror with other ONTAP systems.
3764
+ # @return [Types::FileSystemEndpoint]
2825
3765
  #
2826
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemNotFound AWS API Documentation
3766
+ # @!attribute [rw] management
3767
+ # An endpoint for managing your file system using the NetApp ONTAP CLI
3768
+ # and NetApp ONTAP API.
3769
+ # @return [Types::FileSystemEndpoint]
2827
3770
  #
2828
- class FileSystemNotFound < Struct.new(
3771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemEndpoints AWS API Documentation
3772
+ #
3773
+ class FileSystemEndpoints < Struct.new(
3774
+ :intercluster,
3775
+ :management)
3776
+ SENSITIVE = []
3777
+ include Aws::Structure
3778
+ end
3779
+
3780
+ # A structure providing details of any failures that occur when creating
3781
+ # the file system has failed.
3782
+ #
3783
+ # @!attribute [rw] message
3784
+ # A message describing any failures that occurred during file system
3785
+ # creation.
3786
+ # @return [String]
3787
+ #
3788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemFailureDetails AWS API Documentation
3789
+ #
3790
+ class FileSystemFailureDetails < Struct.new(
3791
+ :message)
3792
+ SENSITIVE = []
3793
+ include Aws::Structure
3794
+ end
3795
+
3796
+ # No Amazon FSx file systems were found based upon supplied parameters.
3797
+ #
3798
+ # @!attribute [rw] message
3799
+ # A detailed error message.
3800
+ # @return [String]
3801
+ #
3802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemNotFound AWS API Documentation
3803
+ #
3804
+ class FileSystemNotFound < Struct.new(
2829
3805
  :message)
2830
3806
  SENSITIVE = []
2831
3807
  include Aws::Structure
@@ -2839,7 +3815,7 @@ module Aws::FSx
2839
3815
  # data as a hash:
2840
3816
  #
2841
3817
  # {
2842
- # name: "file-system-id", # accepts file-system-id, backup-type, file-system-type
3818
+ # name: "file-system-id", # accepts file-system-id, backup-type, file-system-type, volume-id
2843
3819
  # values: ["FilterValue"],
2844
3820
  # }
2845
3821
  #
@@ -2911,8 +3887,8 @@ module Aws::FSx
2911
3887
  include Aws::Structure
2912
3888
  end
2913
3889
 
2914
- # The AWS Key Management Service (AWS KMS) key of the destination backup
2915
- # is invalid.
3890
+ # The Key Management Service (KMS) key of the destination backup is
3891
+ # invalid.
2916
3892
  #
2917
3893
  # @!attribute [rw] message
2918
3894
  # A detailed error message.
@@ -2955,36 +3931,24 @@ module Aws::FSx
2955
3931
  end
2956
3932
 
2957
3933
  # One or more network settings specified in the request are invalid.
2958
- # `InvalidVpcId` means that the ID passed for the virtual private cloud
2959
- # (VPC) is invalid. `InvalidSubnetIds` returns the list of IDs for
2960
- # subnets that are either invalid or not part of the VPC specified.
2961
- # `InvalidSecurityGroupIds` returns the list of IDs for security groups
2962
- # that are either invalid or not part of the VPC specified.
2963
3934
  #
2964
3935
  # @!attribute [rw] message
2965
- # A detailed error message.
3936
+ # Error message explaining what's wrong with network settings.
2966
3937
  # @return [String]
2967
3938
  #
2968
3939
  # @!attribute [rw] invalid_subnet_id
2969
- # The ID for a subnet. A *subnet* is a range of IP addresses in your
2970
- # virtual private cloud (VPC). For more information, see [VPC and
2971
- # Subnets][1] in the *Amazon VPC User Guide.*
2972
- #
2973
- #
2974
- #
2975
- # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html
3940
+ # The subnet ID that is either invalid or not part of the VPC
3941
+ # specified.
2976
3942
  # @return [String]
2977
3943
  #
2978
3944
  # @!attribute [rw] invalid_security_group_id
2979
- # The ID of your Amazon EC2 security group. This ID is used to control
2980
- # network access to the endpoint that Amazon FSx creates on your
2981
- # behalf in each subnet. For more information, see [Amazon EC2
2982
- # Security Groups for Linux Instances][1] in the *Amazon EC2 User
2983
- # Guide*.
2984
- #
2985
- #
3945
+ # The security group ID is either invalid or not part of the VPC
3946
+ # specified.
3947
+ # @return [String]
2986
3948
  #
2987
- # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html
3949
+ # @!attribute [rw] invalid_route_table_id
3950
+ # The route table ID is either invalid or not part of the VPC
3951
+ # specified.
2988
3952
  # @return [String]
2989
3953
  #
2990
3954
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidNetworkSettings AWS API Documentation
@@ -2992,7 +3956,8 @@ module Aws::FSx
2992
3956
  class InvalidNetworkSettings < Struct.new(
2993
3957
  :message,
2994
3958
  :invalid_subnet_id,
2995
- :invalid_security_group_id)
3959
+ :invalid_security_group_id,
3960
+ :invalid_route_table_id)
2996
3961
  SENSITIVE = []
2997
3962
  include Aws::Structure
2998
3963
  end
@@ -3013,7 +3978,7 @@ module Aws::FSx
3013
3978
  end
3014
3979
 
3015
3980
  # The Region provided for `Source Region` is invalid or is in a
3016
- # different AWS partition.
3981
+ # different Amazon Web Services partition.
3017
3982
  #
3018
3983
  # @!attribute [rw] message
3019
3984
  # A detailed error message.
@@ -3027,8 +3992,7 @@ module Aws::FSx
3027
3992
  include Aws::Structure
3028
3993
  end
3029
3994
 
3030
- # The AWS Key Management Service (AWS KMS) key of the source backup is
3031
- # invalid.
3995
+ # The Key Management Service (KMS) key of the source backup is invalid.
3032
3996
  #
3033
3997
  # @!attribute [rw] message
3034
3998
  # A detailed error message.
@@ -3042,6 +4006,20 @@ module Aws::FSx
3042
4006
  include Aws::Structure
3043
4007
  end
3044
4008
 
4009
+ # Describes why a resource lifecycle state changed.
4010
+ #
4011
+ # @!attribute [rw] message
4012
+ # A detailed error message.
4013
+ # @return [String]
4014
+ #
4015
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LifecycleTransitionReason AWS API Documentation
4016
+ #
4017
+ class LifecycleTransitionReason < Struct.new(
4018
+ :message)
4019
+ SENSITIVE = []
4020
+ include Aws::Structure
4021
+ end
4022
+
3045
4023
  # The request object for `ListTagsForResource` operation.
3046
4024
  #
3047
4025
  # @note When making an API call, you may pass ListTagsForResourceRequest
@@ -3151,7 +4129,7 @@ module Aws::FSx
3151
4129
  #
3152
4130
  # For the `SCRATCH_1` deployment type, this value is always "`fsx`".
3153
4131
  # For `SCRATCH_2` and `PERSISTENT_1` deployment types, this value is a
3154
- # string that is unique within an AWS Region.
4132
+ # string that is unique within an Amazon Web Services Region.
3155
4133
  # @return [String]
3156
4134
  #
3157
4135
  # @!attribute [rw] daily_automatic_backup_start_time
@@ -3233,6 +4211,20 @@ module Aws::FSx
3233
4211
  include Aws::Structure
3234
4212
  end
3235
4213
 
4214
+ # A volume configuration is required for this operation.
4215
+ #
4216
+ # @!attribute [rw] message
4217
+ # A detailed error message.
4218
+ # @return [String]
4219
+ #
4220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/MissingVolumeConfiguration AWS API Documentation
4221
+ #
4222
+ class MissingVolumeConfiguration < Struct.new(
4223
+ :message)
4224
+ SENSITIVE = []
4225
+ include Aws::Structure
4226
+ end
4227
+
3236
4228
  # The resource specified for the tagging operation is not a resource
3237
4229
  # type owned by Amazon FSx. Use the API of the relevant service to
3238
4230
  # perform the operation.
@@ -3254,6 +4246,185 @@ module Aws::FSx
3254
4246
  include Aws::Structure
3255
4247
  end
3256
4248
 
4249
+ # Configuration for the FSx for NetApp ONTAP file system.
4250
+ #
4251
+ # @!attribute [rw] automatic_backup_retention_days
4252
+ # The number of days to retain automatic backups. Setting this to 0
4253
+ # disables automatic backups. You can retain automatic backups for a
4254
+ # maximum of 90 days. The default is 0.
4255
+ # @return [Integer]
4256
+ #
4257
+ # @!attribute [rw] daily_automatic_backup_start_time
4258
+ # A recurring daily time, in the format `HH:MM`. `HH` is the
4259
+ # zero-padded hour of the day (0-23), and `MM` is the zero-padded
4260
+ # minute of the hour. For example, `05:00` specifies 5 AM daily.
4261
+ # @return [String]
4262
+ #
4263
+ # @!attribute [rw] deployment_type
4264
+ # The ONTAP file system deployment type.
4265
+ # @return [String]
4266
+ #
4267
+ # @!attribute [rw] endpoint_ip_address_range
4268
+ # The IP address range in which the endpoints to access your file
4269
+ # system are created.
4270
+ # @return [String]
4271
+ #
4272
+ # @!attribute [rw] endpoints
4273
+ # The `Management` and `Intercluster` endpoints that are used to
4274
+ # access data or to manage the file system using the NetApp ONTAP CLI,
4275
+ # REST API, or NetApp SnapMirror.
4276
+ # @return [Types::FileSystemEndpoints]
4277
+ #
4278
+ # @!attribute [rw] disk_iops_configuration
4279
+ # The SSD IOPS configuration for the ONTAP file system, specifying the
4280
+ # number of provisioned IOPS and the provision mode.
4281
+ # @return [Types::DiskIopsConfiguration]
4282
+ #
4283
+ # @!attribute [rw] preferred_subnet_id
4284
+ # The ID for a subnet. A *subnet* is a range of IP addresses in your
4285
+ # virtual private cloud (VPC). For more information, see [VPC and
4286
+ # Subnets][1] in the *Amazon VPC User Guide.*
4287
+ #
4288
+ #
4289
+ #
4290
+ # [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html
4291
+ # @return [String]
4292
+ #
4293
+ # @!attribute [rw] route_table_ids
4294
+ # The VPC route tables in which your file system's endpoints are
4295
+ # created.
4296
+ # @return [Array<String>]
4297
+ #
4298
+ # @!attribute [rw] throughput_capacity
4299
+ # Sustained throughput of an Amazon FSx file system in MBps.
4300
+ # @return [Integer]
4301
+ #
4302
+ # @!attribute [rw] weekly_maintenance_start_time
4303
+ # A recurring weekly time, in the format `D:HH:MM`.
4304
+ #
4305
+ # `D` is the day of the week, for which 1 represents Monday and 7
4306
+ # represents Sunday. For further details, see [the ISO-8601 spec as
4307
+ # described on Wikipedia][1].
4308
+ #
4309
+ # `HH` is the zero-padded hour of the day (0-23), and `MM` is the
4310
+ # zero-padded minute of the hour.
4311
+ #
4312
+ # For example, `1:05:00` specifies maintenance at 5 AM Monday.
4313
+ #
4314
+ #
4315
+ #
4316
+ # [1]: https://en.wikipedia.org/wiki/ISO_week_date
4317
+ # @return [String]
4318
+ #
4319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapFileSystemConfiguration AWS API Documentation
4320
+ #
4321
+ class OntapFileSystemConfiguration < Struct.new(
4322
+ :automatic_backup_retention_days,
4323
+ :daily_automatic_backup_start_time,
4324
+ :deployment_type,
4325
+ :endpoint_ip_address_range,
4326
+ :endpoints,
4327
+ :disk_iops_configuration,
4328
+ :preferred_subnet_id,
4329
+ :route_table_ids,
4330
+ :throughput_capacity,
4331
+ :weekly_maintenance_start_time)
4332
+ SENSITIVE = []
4333
+ include Aws::Structure
4334
+ end
4335
+
4336
+ # The configuration of an Amazon FSx for NetApp ONTAP volume
4337
+ #
4338
+ # @!attribute [rw] flex_cache_endpoint_type
4339
+ # Specifies the FlexCache endpoint type of the volume. Valid values
4340
+ # are the following:
4341
+ #
4342
+ # * `NONE` specifies that the volume doesn't have a FlexCache
4343
+ # configuration. `NONE` is the default.
4344
+ #
4345
+ # * `ORIGIN` specifies that the volume is the origin volume for a
4346
+ # FlexCache volume.
4347
+ #
4348
+ # * `CACHE` specifies that the volume is a FlexCache volume.
4349
+ # @return [String]
4350
+ #
4351
+ # @!attribute [rw] junction_path
4352
+ # Specifies the directory that NAS clients use to mount the volume,
4353
+ # along with the SVM DNS name or IP address. You can create a
4354
+ # `JunctionPath` directly below a parent volume junction or on a
4355
+ # directory within a volume. A `JunctionPath` for a volume named vol3
4356
+ # might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even
4357
+ # /dir1/dir2/vol3..
4358
+ # @return [String]
4359
+ #
4360
+ # @!attribute [rw] security_style
4361
+ # The security style for the volume, which can be `UNIX`, `NTFS`, or
4362
+ # `MIXED`.
4363
+ # @return [String]
4364
+ #
4365
+ # @!attribute [rw] size_in_megabytes
4366
+ # The configured size of the volume, in megabytes (MBs).
4367
+ # @return [Integer]
4368
+ #
4369
+ # @!attribute [rw] storage_efficiency_enabled
4370
+ # The volume's storage efficiency setting.
4371
+ # @return [Boolean]
4372
+ #
4373
+ # @!attribute [rw] storage_virtual_machine_id
4374
+ # The ID of the volume's storage virtual machine.
4375
+ # @return [String]
4376
+ #
4377
+ # @!attribute [rw] storage_virtual_machine_root
4378
+ # A boolean flag indicating whether this volume is the root volume for
4379
+ # its storage virtual machine (SVM). Only one volume on an SVM can be
4380
+ # the root volume. This value defaults to false. If this value is
4381
+ # true, then this is the SVM root volume.
4382
+ #
4383
+ # This flag is useful when you're deleting an SVM, because you must
4384
+ # first delete all non-root volumes. This flag, when set to false,
4385
+ # helps you identify which volumes to delete before you can delete the
4386
+ # SVM.
4387
+ # @return [Boolean]
4388
+ #
4389
+ # @!attribute [rw] tiering_policy
4390
+ # The volume's `TieringPolicy` setting.
4391
+ # @return [Types::TieringPolicy]
4392
+ #
4393
+ # @!attribute [rw] uuid
4394
+ # The volume's UUID (universally unique identifier).
4395
+ # @return [String]
4396
+ #
4397
+ # @!attribute [rw] ontap_volume_type
4398
+ # Specifies the type of volume. Valid values are the following:
4399
+ #
4400
+ # * `RW` specifies a read-write volume. `RW` is the default.
4401
+ #
4402
+ # * `DP` specifies a data protection volume. You can protect data by
4403
+ # replicating it to data protection mirror copies and use data
4404
+ # protection mirror copies to recover data when a disaster occurs.
4405
+ #
4406
+ # * `LS` specifies a load-sharing mirror volume. A load-sharing mirror
4407
+ # reduces the network traffic to a FlexVol volume by providing
4408
+ # additional read-only access to clients.
4409
+ # @return [String]
4410
+ #
4411
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapVolumeConfiguration AWS API Documentation
4412
+ #
4413
+ class OntapVolumeConfiguration < Struct.new(
4414
+ :flex_cache_endpoint_type,
4415
+ :junction_path,
4416
+ :security_style,
4417
+ :size_in_megabytes,
4418
+ :storage_efficiency_enabled,
4419
+ :storage_virtual_machine_id,
4420
+ :storage_virtual_machine_root,
4421
+ :tiering_policy,
4422
+ :uuid,
4423
+ :ontap_volume_type)
4424
+ SENSITIVE = []
4425
+ include Aws::Structure
4426
+ end
4427
+
3257
4428
  # The resource specified does not support tagging.
3258
4429
  #
3259
4430
  # @!attribute [rw] resource_arn
@@ -3295,7 +4466,8 @@ module Aws::FSx
3295
4466
  end
3296
4467
 
3297
4468
  # The configuration of the self-managed Microsoft Active Directory (AD)
3298
- # directory to which the Windows File Server instance is joined.
4469
+ # directory to which the Windows File Server or ONTAP storage virtual
4470
+ # machine (SVM) instance is joined.
3299
4471
  #
3300
4472
  # @!attribute [rw] domain_name
3301
4473
  # The fully qualified domain name of the self-managed AD directory.
@@ -3304,7 +4476,7 @@ module Aws::FSx
3304
4476
  # @!attribute [rw] organizational_unit_distinguished_name
3305
4477
  # The fully qualified distinguished name of the organizational unit
3306
4478
  # within the self-managed AD directory to which the Windows File
3307
- # Server instance is joined.
4479
+ # Server or ONTAP storage virtual machine (SVM) instance is joined.
3308
4480
  # @return [String]
3309
4481
  #
3310
4482
  # @!attribute [rw] file_system_administrators_group
@@ -3318,7 +4490,7 @@ module Aws::FSx
3318
4490
  # @return [String]
3319
4491
  #
3320
4492
  # @!attribute [rw] dns_ips
3321
- # A list of up to two IP addresses of DNS servers or domain
4493
+ # A list of up to three IP addresses of DNS servers or domain
3322
4494
  # controllers in the self-managed AD directory.
3323
4495
  # @return [Array<String>]
3324
4496
  #
@@ -3334,14 +4506,16 @@ module Aws::FSx
3334
4506
  include Aws::Structure
3335
4507
  end
3336
4508
 
3337
- # The configuration that Amazon FSx uses to join the Windows File Server
3338
- # instance to your self-managed (including on-premises) Microsoft Active
3339
- # Directory (AD) directory. For more information, see [ Using Amazon FSx
3340
- # with your self-managed Microsoft Active Directory][1].
4509
+ # The configuration that Amazon FSx uses to join a FSx for Windows File
4510
+ # Server file system or an ONTAP storage virtual machine (SVM) to a
4511
+ # self-managed (including on-premises) Microsoft Active Directory (AD)
4512
+ # directory. For more information, see [ Using Amazon FSx with your
4513
+ # self-managed Microsoft Active Directory][1] or [Managing SVMs][2].
3341
4514
  #
3342
4515
  #
3343
4516
  #
3344
4517
  # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
4518
+ # [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
3345
4519
  #
3346
4520
  # @note When making an API call, you may pass SelfManagedActiveDirectoryConfiguration
3347
4521
  # data as a hash:
@@ -3362,12 +4536,11 @@ module Aws::FSx
3362
4536
  #
3363
4537
  # @!attribute [rw] organizational_unit_distinguished_name
3364
4538
  # (Optional) The fully qualified distinguished name of the
3365
- # organizational unit within your self-managed AD directory that the
3366
- # Windows File Server instance will join. Amazon FSx only accepts OU
3367
- # as the direct parent of the file system. An example is
3368
- # `OU=FSx,DC=yourdomain,DC=corp,DC=com`. To learn more, see [RFC
3369
- # 2253][1]. If none is provided, the FSx file system is created in the
3370
- # default location of your self-managed AD directory.
4539
+ # organizational unit within your self-managed AD directory. Amazon
4540
+ # FSx only accepts OU as the direct parent of the file system. An
4541
+ # example is `OU=FSx,DC=yourdomain,DC=corp,DC=com`. To learn more, see
4542
+ # [RFC 2253][1]. If none is provided, the FSx file system is created
4543
+ # in the default location of your self-managed AD directory.
3371
4544
  #
3372
4545
  # Only Organizational Unit (OU) objects can be the direct parent of
3373
4546
  # the file system that you're creating.
@@ -3402,7 +4575,7 @@ module Aws::FSx
3402
4575
  # @return [String]
3403
4576
  #
3404
4577
  # @!attribute [rw] dns_ips
3405
- # A list of up to two IP addresses of DNS servers or domain
4578
+ # A list of up to three IP addresses of DNS servers or domain
3406
4579
  # controllers in the self-managed AD directory.
3407
4580
  # @return [Array<String>]
3408
4581
  #
@@ -3445,7 +4618,7 @@ module Aws::FSx
3445
4618
  # @return [String]
3446
4619
  #
3447
4620
  # @!attribute [rw] dns_ips
3448
- # A list of up to two IP addresses of DNS servers or domain
4621
+ # A list of up to three IP addresses of DNS servers or domain
3449
4622
  # controllers in the self-managed AD directory.
3450
4623
  # @return [Array<String>]
3451
4624
  #
@@ -3460,7 +4633,8 @@ module Aws::FSx
3460
4633
  end
3461
4634
 
3462
4635
  # An error indicating that a particular service limit was exceeded. You
3463
- # can increase some service limits by contacting AWS Support.
4636
+ # can increase some service limits by contacting Amazon Web Services
4637
+ # Support.
3464
4638
  #
3465
4639
  # @!attribute [rw] limit
3466
4640
  # Enumeration of the service limit that was exceeded.
@@ -3499,93 +4673,367 @@ module Aws::FSx
3499
4673
  include Aws::Structure
3500
4674
  end
3501
4675
 
3502
- # Specifies a key-value pair for a resource tag.
4676
+ # Describes the Amazon FSx for NetApp ONTAP storage virtual machine
4677
+ # (SVM) configuraton.
3503
4678
  #
3504
- # @note When making an API call, you may pass Tag
3505
- # data as a hash:
4679
+ # @!attribute [rw] active_directory_configuration
4680
+ # Describes the Microsoft Active Directory configuration to which the
4681
+ # SVM is joined, if applicable.
4682
+ # @return [Types::SvmActiveDirectoryConfiguration]
3506
4683
  #
3507
- # {
3508
- # key: "TagKey", # required
3509
- # value: "TagValue", # required
3510
- # }
4684
+ # @!attribute [rw] creation_time
4685
+ # The time that the resource was created, in seconds (since
4686
+ # 1970-01-01T00:00:00Z), also known as Unix time.
4687
+ # @return [Time]
3511
4688
  #
3512
- # @!attribute [rw] key
3513
- # A value that specifies the `TagKey`, the name of the tag. Tag keys
3514
- # must be unique for the resource to which they are attached.
4689
+ # @!attribute [rw] endpoints
4690
+ # The endpoints that are used to access data or to manage the SVM
4691
+ # using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They
4692
+ # are the `Iscsi`, `Management`, `Nfs`, and `Smb` endpoints.
4693
+ # @return [Types::SvmEndpoints]
4694
+ #
4695
+ # @!attribute [rw] file_system_id
4696
+ # The globally unique ID of the file system, assigned by Amazon FSx.
3515
4697
  # @return [String]
3516
4698
  #
3517
- # @!attribute [rw] value
3518
- # A value that specifies the `TagValue`, the value assigned to the
3519
- # corresponding tag key. Tag values can be null and don't have to be
3520
- # unique in a tag set. For example, you can have a key-value pair in a
3521
- # tag set of `finances : April` and also of `payroll : April`.
4699
+ # @!attribute [rw] lifecycle
4700
+ # Describes the SVM's lifecycle status.
4701
+ #
4702
+ # * `CREATED` - The SVM is fully available for use.
4703
+ #
4704
+ # * `CREATING` - Amazon FSx is creating the new SVM.
4705
+ #
4706
+ # * `DELETING` - Amazon FSx is deleting an existing SVM.
4707
+ #
4708
+ # * `FAILED` - Amazon FSx was unable to create the SVM.
4709
+ #
4710
+ # * `MISCONFIGURED` - The SVM is in a failed but recoverable state.
4711
+ #
4712
+ # * `PENDING` - Amazon FSx has not started creating the SVM.
3522
4713
  # @return [String]
3523
4714
  #
3524
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Tag AWS API Documentation
4715
+ # @!attribute [rw] name
4716
+ # The name of the SVM, if provisioned.
4717
+ # @return [String]
3525
4718
  #
3526
- class Tag < Struct.new(
3527
- :key,
3528
- :value)
4719
+ # @!attribute [rw] resource_arn
4720
+ # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
4721
+ # identify Amazon Web Services resources. We require an ARN when you
4722
+ # need to specify a resource unambiguously across all of Amazon Web
4723
+ # Services. For more information, see [Amazon Resource Names
4724
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
4725
+ #
4726
+ #
4727
+ #
4728
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
4729
+ # @return [String]
4730
+ #
4731
+ # @!attribute [rw] storage_virtual_machine_id
4732
+ # The SVM's system generated unique ID.
4733
+ # @return [String]
4734
+ #
4735
+ # @!attribute [rw] subtype
4736
+ # Describes the SVM's subtype.
4737
+ # @return [String]
4738
+ #
4739
+ # @!attribute [rw] uuid
4740
+ # The SVM's UUID (universally unique identifier).
4741
+ # @return [String]
4742
+ #
4743
+ # @!attribute [rw] tags
4744
+ # A list of `Tag` values, with a maximum of 50 elements.
4745
+ # @return [Array<Types::Tag>]
4746
+ #
4747
+ # @!attribute [rw] lifecycle_transition_reason
4748
+ # Describes why the SVM lifecycle state changed.
4749
+ # @return [Types::LifecycleTransitionReason]
4750
+ #
4751
+ # @!attribute [rw] root_volume_security_style
4752
+ # The security style of the root volume of the SVM.
4753
+ # @return [String]
4754
+ #
4755
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachine AWS API Documentation
4756
+ #
4757
+ class StorageVirtualMachine < Struct.new(
4758
+ :active_directory_configuration,
4759
+ :creation_time,
4760
+ :endpoints,
4761
+ :file_system_id,
4762
+ :lifecycle,
4763
+ :name,
4764
+ :resource_arn,
4765
+ :storage_virtual_machine_id,
4766
+ :subtype,
4767
+ :uuid,
4768
+ :tags,
4769
+ :lifecycle_transition_reason,
4770
+ :root_volume_security_style)
3529
4771
  SENSITIVE = []
3530
4772
  include Aws::Structure
3531
4773
  end
3532
4774
 
3533
- # The request object for the `TagResource` operation.
4775
+ # A filter used to restrict the results of describe calls for Amazon FSx
4776
+ # for NetApp ONTAP storage virtual machines (SVMs). You can use multiple
4777
+ # filters to return results that meet all applied filter requirements.
3534
4778
  #
3535
- # @note When making an API call, you may pass TagResourceRequest
4779
+ # @note When making an API call, you may pass StorageVirtualMachineFilter
3536
4780
  # data as a hash:
3537
4781
  #
3538
4782
  # {
3539
- # resource_arn: "ResourceARN", # required
3540
- # tags: [ # required
3541
- # {
3542
- # key: "TagKey", # required
3543
- # value: "TagValue", # required
3544
- # },
3545
- # ],
4783
+ # name: "file-system-id", # accepts file-system-id
4784
+ # values: ["StorageVirtualMachineFilterValue"],
3546
4785
  # }
3547
4786
  #
3548
- # @!attribute [rw] resource_arn
3549
- # The Amazon Resource Name (ARN) of the Amazon FSx resource that you
3550
- # want to tag.
4787
+ # @!attribute [rw] name
4788
+ # The name for this filter.
3551
4789
  # @return [String]
3552
4790
  #
3553
- # @!attribute [rw] tags
3554
- # A list of tags for the resource. If a tag with a given key already
3555
- # exists, the value is replaced by the one specified in this
3556
- # parameter.
3557
- # @return [Array<Types::Tag>]
4791
+ # @!attribute [rw] values
4792
+ # The values of the filter. These are all the values for any of the
4793
+ # applied filters.
4794
+ # @return [Array<String>]
3558
4795
  #
3559
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceRequest AWS API Documentation
4796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachineFilter AWS API Documentation
3560
4797
  #
3561
- class TagResourceRequest < Struct.new(
3562
- :resource_arn,
3563
- :tags)
4798
+ class StorageVirtualMachineFilter < Struct.new(
4799
+ :name,
4800
+ :values)
3564
4801
  SENSITIVE = []
3565
4802
  include Aws::Structure
3566
4803
  end
3567
4804
 
3568
- # The response object for the `TagResource` operation.
3569
- #
3570
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceResponse AWS API Documentation
3571
- #
3572
- class TagResourceResponse < Aws::EmptyStructure; end
3573
-
3574
- # The requested operation is not supported for this resource or API.
4805
+ # No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied
4806
+ # parameters.
3575
4807
  #
3576
4808
  # @!attribute [rw] message
3577
4809
  # A detailed error message.
3578
4810
  # @return [String]
3579
4811
  #
3580
- # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UnsupportedOperation AWS API Documentation
4812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachineNotFound AWS API Documentation
3581
4813
  #
3582
- class UnsupportedOperation < Struct.new(
4814
+ class StorageVirtualMachineNotFound < Struct.new(
3583
4815
  :message)
3584
4816
  SENSITIVE = []
3585
4817
  include Aws::Structure
3586
4818
  end
3587
4819
 
3588
- # The request object for `UntagResource` action.
4820
+ # Describes the configuration of the Microsoft Active Directory (AD)
4821
+ # directory to which the Amazon FSx for ONTAP storage virtual machine
4822
+ # (SVM) is joined. Pleae note, account credentials are not returned in
4823
+ # the response payload.
4824
+ #
4825
+ # @!attribute [rw] net_bios_name
4826
+ # The NetBIOS name of the Active Directory computer object that is
4827
+ # joined to your SVM.
4828
+ # @return [String]
4829
+ #
4830
+ # @!attribute [rw] self_managed_active_directory_configuration
4831
+ # The configuration of the self-managed Microsoft Active Directory
4832
+ # (AD) directory to which the Windows File Server or ONTAP storage
4833
+ # virtual machine (SVM) instance is joined.
4834
+ # @return [Types::SelfManagedActiveDirectoryAttributes]
4835
+ #
4836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmActiveDirectoryConfiguration AWS API Documentation
4837
+ #
4838
+ class SvmActiveDirectoryConfiguration < Struct.new(
4839
+ :net_bios_name,
4840
+ :self_managed_active_directory_configuration)
4841
+ SENSITIVE = []
4842
+ include Aws::Structure
4843
+ end
4844
+
4845
+ # An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four
4846
+ # endpoints that are used to access data or to manage the SVM using the
4847
+ # NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the
4848
+ # `Iscsi`, `Management`, `Nfs`, and `Smb` endpoints.
4849
+ #
4850
+ # @!attribute [rw] dns_name
4851
+ # The Domain Name Service (DNS) name for the file system. You can
4852
+ # mount your file system using its DNS name.
4853
+ # @return [String]
4854
+ #
4855
+ # @!attribute [rw] ip_addresses
4856
+ # The SVM endpoint's IP addresses.
4857
+ # @return [Array<String>]
4858
+ #
4859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmEndpoint AWS API Documentation
4860
+ #
4861
+ class SvmEndpoint < Struct.new(
4862
+ :dns_name,
4863
+ :ip_addresses)
4864
+ SENSITIVE = []
4865
+ include Aws::Structure
4866
+ end
4867
+
4868
+ # An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the
4869
+ # following endpoints that are used to access data or to manage the SVM
4870
+ # using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.
4871
+ #
4872
+ # @!attribute [rw] iscsi
4873
+ # An endpoint for connecting using the Internet Small Computer Systems
4874
+ # Interface (iSCSI) protocol.
4875
+ # @return [Types::SvmEndpoint]
4876
+ #
4877
+ # @!attribute [rw] management
4878
+ # An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp
4879
+ # ONTAP API, or NetApp CloudManager.
4880
+ # @return [Types::SvmEndpoint]
4881
+ #
4882
+ # @!attribute [rw] nfs
4883
+ # An endpoint for connecting using the Network File System (NFS)
4884
+ # protocol.
4885
+ # @return [Types::SvmEndpoint]
4886
+ #
4887
+ # @!attribute [rw] smb
4888
+ # An endpoint for connecting using the Server Message Block (SMB)
4889
+ # protocol.
4890
+ # @return [Types::SvmEndpoint]
4891
+ #
4892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmEndpoints AWS API Documentation
4893
+ #
4894
+ class SvmEndpoints < Struct.new(
4895
+ :iscsi,
4896
+ :management,
4897
+ :nfs,
4898
+ :smb)
4899
+ SENSITIVE = []
4900
+ include Aws::Structure
4901
+ end
4902
+
4903
+ # Specifies a key-value pair for a resource tag.
4904
+ #
4905
+ # @note When making an API call, you may pass Tag
4906
+ # data as a hash:
4907
+ #
4908
+ # {
4909
+ # key: "TagKey", # required
4910
+ # value: "TagValue", # required
4911
+ # }
4912
+ #
4913
+ # @!attribute [rw] key
4914
+ # A value that specifies the `TagKey`, the name of the tag. Tag keys
4915
+ # must be unique for the resource to which they are attached.
4916
+ # @return [String]
4917
+ #
4918
+ # @!attribute [rw] value
4919
+ # A value that specifies the `TagValue`, the value assigned to the
4920
+ # corresponding tag key. Tag values can be null and don't have to be
4921
+ # unique in a tag set. For example, you can have a key-value pair in a
4922
+ # tag set of `finances : April` and also of `payroll : April`.
4923
+ # @return [String]
4924
+ #
4925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Tag AWS API Documentation
4926
+ #
4927
+ class Tag < Struct.new(
4928
+ :key,
4929
+ :value)
4930
+ SENSITIVE = []
4931
+ include Aws::Structure
4932
+ end
4933
+
4934
+ # The request object for the `TagResource` operation.
4935
+ #
4936
+ # @note When making an API call, you may pass TagResourceRequest
4937
+ # data as a hash:
4938
+ #
4939
+ # {
4940
+ # resource_arn: "ResourceARN", # required
4941
+ # tags: [ # required
4942
+ # {
4943
+ # key: "TagKey", # required
4944
+ # value: "TagValue", # required
4945
+ # },
4946
+ # ],
4947
+ # }
4948
+ #
4949
+ # @!attribute [rw] resource_arn
4950
+ # The Amazon Resource Name (ARN) of the Amazon FSx resource that you
4951
+ # want to tag.
4952
+ # @return [String]
4953
+ #
4954
+ # @!attribute [rw] tags
4955
+ # A list of tags for the resource. If a tag with a given key already
4956
+ # exists, the value is replaced by the one specified in this
4957
+ # parameter.
4958
+ # @return [Array<Types::Tag>]
4959
+ #
4960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceRequest AWS API Documentation
4961
+ #
4962
+ class TagResourceRequest < Struct.new(
4963
+ :resource_arn,
4964
+ :tags)
4965
+ SENSITIVE = []
4966
+ include Aws::Structure
4967
+ end
4968
+
4969
+ # The response object for the `TagResource` operation.
4970
+ #
4971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceResponse AWS API Documentation
4972
+ #
4973
+ class TagResourceResponse < Aws::EmptyStructure; end
4974
+
4975
+ # Describes the data tiering policy for an ONTAP volume. When enabled,
4976
+ # Amazon FSx for ONTAP's intelligent tiering automatically transitions
4977
+ # a volume's data between the file system's primary storage and
4978
+ # capacity pool storage based on your access patterns.
4979
+ #
4980
+ # @note When making an API call, you may pass TieringPolicy
4981
+ # data as a hash:
4982
+ #
4983
+ # {
4984
+ # cooling_period: 1,
4985
+ # name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
4986
+ # }
4987
+ #
4988
+ # @!attribute [rw] cooling_period
4989
+ # Specifies the number of days that user data in a volume must remain
4990
+ # inactive before it is considered "cold" and moved to the capacity
4991
+ # pool. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies.
4992
+ # Enter a whole number between 2 and 183. Default values are 31 days
4993
+ # for `AUTO` and 2 days for `SNAPSHOT_ONLY`.
4994
+ # @return [Integer]
4995
+ #
4996
+ # @!attribute [rw] name
4997
+ # Specifies the tiering policy used to transition data. Default value
4998
+ # is `SNAPSHOT_ONLY`.
4999
+ #
5000
+ # * `SNAPSHOT_ONLY` - moves cold snapshots to the capacity pool
5001
+ # storage tier.
5002
+ #
5003
+ # * `AUTO` - moves cold user data and snapshots to the capacity pool
5004
+ # storage tier based on your access patterns.
5005
+ #
5006
+ # * `ALL` - moves all user data blocks in both the active file system
5007
+ # and Snapshot copies to the storage pool tier.
5008
+ #
5009
+ # * `NONE` - keeps a volume's data in the primary storage tier,
5010
+ # preventing it from being moved to the capacity pool tier.
5011
+ # @return [String]
5012
+ #
5013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TieringPolicy AWS API Documentation
5014
+ #
5015
+ class TieringPolicy < Struct.new(
5016
+ :cooling_period,
5017
+ :name)
5018
+ SENSITIVE = []
5019
+ include Aws::Structure
5020
+ end
5021
+
5022
+ # The requested operation is not supported for this resource or API.
5023
+ #
5024
+ # @!attribute [rw] message
5025
+ # A detailed error message.
5026
+ # @return [String]
5027
+ #
5028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UnsupportedOperation AWS API Documentation
5029
+ #
5030
+ class UnsupportedOperation < Struct.new(
5031
+ :message)
5032
+ SENSITIVE = []
5033
+ include Aws::Structure
5034
+ end
5035
+
5036
+ # The request object for `UntagResource` action.
3589
5037
  #
3590
5038
  # @note When making an API call, you may pass UntagResourceRequest
3591
5039
  # data as a hash:
@@ -3710,6 +5158,63 @@ module Aws::FSx
3710
5158
  include Aws::Structure
3711
5159
  end
3712
5160
 
5161
+ # The configuration updates for an Amazon FSx for NetApp ONTAP file
5162
+ # system.
5163
+ #
5164
+ # @note When making an API call, you may pass UpdateFileSystemOntapConfiguration
5165
+ # data as a hash:
5166
+ #
5167
+ # {
5168
+ # automatic_backup_retention_days: 1,
5169
+ # daily_automatic_backup_start_time: "DailyTime",
5170
+ # fsx_admin_password: "AdminPassword",
5171
+ # weekly_maintenance_start_time: "WeeklyTime",
5172
+ # }
5173
+ #
5174
+ # @!attribute [rw] automatic_backup_retention_days
5175
+ # The number of days to retain automatic backups. Setting this to 0
5176
+ # disables automatic backups. You can retain automatic backups for a
5177
+ # maximum of 90 days. The default is 0.
5178
+ # @return [Integer]
5179
+ #
5180
+ # @!attribute [rw] daily_automatic_backup_start_time
5181
+ # A recurring daily time, in the format `HH:MM`. `HH` is the
5182
+ # zero-padded hour of the day (0-23), and `MM` is the zero-padded
5183
+ # minute of the hour. For example, `05:00` specifies 5 AM daily.
5184
+ # @return [String]
5185
+ #
5186
+ # @!attribute [rw] fsx_admin_password
5187
+ # The ONTAP administrative password for the `fsxadmin` user.
5188
+ # @return [String]
5189
+ #
5190
+ # @!attribute [rw] weekly_maintenance_start_time
5191
+ # A recurring weekly time, in the format `D:HH:MM`.
5192
+ #
5193
+ # `D` is the day of the week, for which 1 represents Monday and 7
5194
+ # represents Sunday. For further details, see [the ISO-8601 spec as
5195
+ # described on Wikipedia][1].
5196
+ #
5197
+ # `HH` is the zero-padded hour of the day (0-23), and `MM` is the
5198
+ # zero-padded minute of the hour.
5199
+ #
5200
+ # For example, `1:05:00` specifies maintenance at 5 AM Monday.
5201
+ #
5202
+ #
5203
+ #
5204
+ # [1]: https://en.wikipedia.org/wiki/ISO_week_date
5205
+ # @return [String]
5206
+ #
5207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemOntapConfiguration AWS API Documentation
5208
+ #
5209
+ class UpdateFileSystemOntapConfiguration < Struct.new(
5210
+ :automatic_backup_retention_days,
5211
+ :daily_automatic_backup_start_time,
5212
+ :fsx_admin_password,
5213
+ :weekly_maintenance_start_time)
5214
+ SENSITIVE = [:fsx_admin_password]
5215
+ include Aws::Structure
5216
+ end
5217
+
3713
5218
  # The request object for the `UpdateFileSystem` operation.
3714
5219
  #
3715
5220
  # @note When making an API call, you may pass UpdateFileSystemRequest
@@ -3742,6 +5247,12 @@ module Aws::FSx
3742
5247
  # auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED
3743
5248
  # data_compression_type: "NONE", # accepts NONE, LZ4
3744
5249
  # },
5250
+ # ontap_configuration: {
5251
+ # automatic_backup_retention_days: 1,
5252
+ # daily_automatic_backup_start_time: "DailyTime",
5253
+ # fsx_admin_password: "AdminPassword",
5254
+ # weekly_maintenance_start_time: "WeeklyTime",
5255
+ # },
3745
5256
  # }
3746
5257
  #
3747
5258
  # @!attribute [rw] file_system_id
@@ -3751,8 +5262,8 @@ module Aws::FSx
3751
5262
  # @!attribute [rw] client_request_token
3752
5263
  # A string of up to 64 ASCII characters that Amazon FSx uses to ensure
3753
5264
  # idempotent updates. This string is automatically filled on your
3754
- # behalf when you use the AWS Command Line Interface (AWS CLI) or an
3755
- # AWS SDK.
5265
+ # behalf when you use the Command Line Interface (CLI) or an Amazon
5266
+ # Web Services SDK.
3756
5267
  #
3757
5268
  # **A suitable default value is auto-generated.** You should normally
3758
5269
  # not need to pass this option.
@@ -3760,10 +5271,11 @@ module Aws::FSx
3760
5271
  #
3761
5272
  # @!attribute [rw] storage_capacity
3762
5273
  # Use this parameter to increase the storage capacity of an Amazon FSx
3763
- # file system. Specifies the storage capacity target value, GiB, to
3764
- # increase the storage capacity for the file system that you're
3765
- # updating. You cannot make a storage capacity increase request if
3766
- # there is an existing storage capacity increase request in progress.
5274
+ # for Windows File Server or Amazon FSx for Lustre file system.
5275
+ # Specifies the storage capacity target value, GiB, to increase the
5276
+ # storage capacity for the file system that you're updating. You
5277
+ # cannot make a storage capacity increase request if there is an
5278
+ # existing storage capacity increase request in progress.
3767
5279
  #
3768
5280
  # For Windows file systems, the storage capacity target value must be
3769
5281
  # at least 10 percent (%) greater than the current storage capacity
@@ -3806,6 +5318,11 @@ module Aws::FSx
3806
5318
  # in the `UpdateFileSystem` operation.
3807
5319
  # @return [Types::UpdateFileSystemLustreConfiguration]
3808
5320
  #
5321
+ # @!attribute [rw] ontap_configuration
5322
+ # The configuration updates for an Amazon FSx for NetApp ONTAP file
5323
+ # system.
5324
+ # @return [Types::UpdateFileSystemOntapConfiguration]
5325
+ #
3809
5326
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemRequest AWS API Documentation
3810
5327
  #
3811
5328
  class UpdateFileSystemRequest < Struct.new(
@@ -3813,7 +5330,8 @@ module Aws::FSx
3813
5330
  :client_request_token,
3814
5331
  :storage_capacity,
3815
5332
  :windows_configuration,
3816
- :lustre_configuration)
5333
+ :lustre_configuration,
5334
+ :ontap_configuration)
3817
5335
  SENSITIVE = []
3818
5336
  include Aws::Structure
3819
5337
  end
@@ -3917,6 +5435,338 @@ module Aws::FSx
3917
5435
  include Aws::Structure
3918
5436
  end
3919
5437
 
5438
+ # Used to specify changes to the ONTAP configuration for the volume you
5439
+ # are updating.
5440
+ #
5441
+ # @note When making an API call, you may pass UpdateOntapVolumeConfiguration
5442
+ # data as a hash:
5443
+ #
5444
+ # {
5445
+ # junction_path: "JunctionPath",
5446
+ # security_style: "UNIX", # accepts UNIX, NTFS, MIXED
5447
+ # size_in_megabytes: 1,
5448
+ # storage_efficiency_enabled: false,
5449
+ # tiering_policy: {
5450
+ # cooling_period: 1,
5451
+ # name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
5452
+ # },
5453
+ # }
5454
+ #
5455
+ # @!attribute [rw] junction_path
5456
+ # Specifies the location in the SVM's namespace where the volume is
5457
+ # mounted. The `JunctionPath` must have a leading forward slash, such
5458
+ # as `/vol3`.
5459
+ # @return [String]
5460
+ #
5461
+ # @!attribute [rw] security_style
5462
+ # The security style for the volume, which can be `UNIX`. `NTFS`, or
5463
+ # `MIXED`.
5464
+ # @return [String]
5465
+ #
5466
+ # @!attribute [rw] size_in_megabytes
5467
+ # Specifies the size of the volume in megabytes.
5468
+ # @return [Integer]
5469
+ #
5470
+ # @!attribute [rw] storage_efficiency_enabled
5471
+ # Default is `false`. Set to true to enable the deduplication,
5472
+ # compression, and compaction storage efficiency features on the
5473
+ # volume.
5474
+ # @return [Boolean]
5475
+ #
5476
+ # @!attribute [rw] tiering_policy
5477
+ # Update the volume's data tiering policy.
5478
+ # @return [Types::TieringPolicy]
5479
+ #
5480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateOntapVolumeConfiguration AWS API Documentation
5481
+ #
5482
+ class UpdateOntapVolumeConfiguration < Struct.new(
5483
+ :junction_path,
5484
+ :security_style,
5485
+ :size_in_megabytes,
5486
+ :storage_efficiency_enabled,
5487
+ :tiering_policy)
5488
+ SENSITIVE = []
5489
+ include Aws::Structure
5490
+ end
5491
+
5492
+ # @note When making an API call, you may pass UpdateStorageVirtualMachineRequest
5493
+ # data as a hash:
5494
+ #
5495
+ # {
5496
+ # active_directory_configuration: {
5497
+ # self_managed_active_directory_configuration: {
5498
+ # user_name: "DirectoryUserName",
5499
+ # password: "DirectoryPassword",
5500
+ # dns_ips: ["IpAddress"],
5501
+ # },
5502
+ # },
5503
+ # client_request_token: "ClientRequestToken",
5504
+ # storage_virtual_machine_id: "StorageVirtualMachineId", # required
5505
+ # svm_admin_password: "AdminPassword",
5506
+ # }
5507
+ #
5508
+ # @!attribute [rw] active_directory_configuration
5509
+ # Updates the Microsoft Active Directory (AD) configuration for an SVM
5510
+ # that is joined to an AD.
5511
+ # @return [Types::UpdateSvmActiveDirectoryConfiguration]
5512
+ #
5513
+ # @!attribute [rw] client_request_token
5514
+ # (Optional) An idempotency token for resource creation, in a string
5515
+ # of up to 64 ASCII characters. This token is automatically filled on
5516
+ # your behalf when you use the Command Line Interface (CLI) or an
5517
+ # Amazon Web Services SDK.
5518
+ #
5519
+ # **A suitable default value is auto-generated.** You should normally
5520
+ # not need to pass this option.
5521
+ # @return [String]
5522
+ #
5523
+ # @!attribute [rw] storage_virtual_machine_id
5524
+ # The ID of the SVM that you want to update, in the format
5525
+ # `svm-0123456789abcdef0`.
5526
+ # @return [String]
5527
+ #
5528
+ # @!attribute [rw] svm_admin_password
5529
+ # Enter a new SvmAdminPassword if you are updating it.
5530
+ # @return [String]
5531
+ #
5532
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachineRequest AWS API Documentation
5533
+ #
5534
+ class UpdateStorageVirtualMachineRequest < Struct.new(
5535
+ :active_directory_configuration,
5536
+ :client_request_token,
5537
+ :storage_virtual_machine_id,
5538
+ :svm_admin_password)
5539
+ SENSITIVE = [:svm_admin_password]
5540
+ include Aws::Structure
5541
+ end
5542
+
5543
+ # @!attribute [rw] storage_virtual_machine
5544
+ # Describes the Amazon FSx for NetApp ONTAP storage virtual machine
5545
+ # (SVM) configuraton.
5546
+ # @return [Types::StorageVirtualMachine]
5547
+ #
5548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachineResponse AWS API Documentation
5549
+ #
5550
+ class UpdateStorageVirtualMachineResponse < Struct.new(
5551
+ :storage_virtual_machine)
5552
+ SENSITIVE = []
5553
+ include Aws::Structure
5554
+ end
5555
+
5556
+ # Updates the Microsoft Active Directory (AD) configuration of an SVM
5557
+ # joined to an AD. Pleae note, account credentials are not returned in
5558
+ # the response payload.
5559
+ #
5560
+ # @note When making an API call, you may pass UpdateSvmActiveDirectoryConfiguration
5561
+ # data as a hash:
5562
+ #
5563
+ # {
5564
+ # self_managed_active_directory_configuration: {
5565
+ # user_name: "DirectoryUserName",
5566
+ # password: "DirectoryPassword",
5567
+ # dns_ips: ["IpAddress"],
5568
+ # },
5569
+ # }
5570
+ #
5571
+ # @!attribute [rw] self_managed_active_directory_configuration
5572
+ # The configuration that Amazon FSx uses to join the Windows File
5573
+ # Server instance to a self-managed Microsoft Active Directory (AD)
5574
+ # directory.
5575
+ # @return [Types::SelfManagedActiveDirectoryConfigurationUpdates]
5576
+ #
5577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSvmActiveDirectoryConfiguration AWS API Documentation
5578
+ #
5579
+ class UpdateSvmActiveDirectoryConfiguration < Struct.new(
5580
+ :self_managed_active_directory_configuration)
5581
+ SENSITIVE = []
5582
+ include Aws::Structure
5583
+ end
5584
+
5585
+ # @note When making an API call, you may pass UpdateVolumeRequest
5586
+ # data as a hash:
5587
+ #
5588
+ # {
5589
+ # client_request_token: "ClientRequestToken",
5590
+ # volume_id: "VolumeId", # required
5591
+ # ontap_configuration: {
5592
+ # junction_path: "JunctionPath",
5593
+ # security_style: "UNIX", # accepts UNIX, NTFS, MIXED
5594
+ # size_in_megabytes: 1,
5595
+ # storage_efficiency_enabled: false,
5596
+ # tiering_policy: {
5597
+ # cooling_period: 1,
5598
+ # name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
5599
+ # },
5600
+ # },
5601
+ # }
5602
+ #
5603
+ # @!attribute [rw] client_request_token
5604
+ # (Optional) An idempotency token for resource creation, in a string
5605
+ # of up to 64 ASCII characters. This token is automatically filled on
5606
+ # your behalf when you use the Command Line Interface (CLI) or an
5607
+ # Amazon Web Services SDK.
5608
+ #
5609
+ # **A suitable default value is auto-generated.** You should normally
5610
+ # not need to pass this option.
5611
+ # @return [String]
5612
+ #
5613
+ # @!attribute [rw] volume_id
5614
+ # Specifies the volume that you want to update, formatted
5615
+ # `fsvol-0123456789abcdef0`.
5616
+ # @return [String]
5617
+ #
5618
+ # @!attribute [rw] ontap_configuration
5619
+ # The `ONTAP` configuration of the volume you are updating.
5620
+ # @return [Types::UpdateOntapVolumeConfiguration]
5621
+ #
5622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolumeRequest AWS API Documentation
5623
+ #
5624
+ class UpdateVolumeRequest < Struct.new(
5625
+ :client_request_token,
5626
+ :volume_id,
5627
+ :ontap_configuration)
5628
+ SENSITIVE = []
5629
+ include Aws::Structure
5630
+ end
5631
+
5632
+ # @!attribute [rw] volume
5633
+ # Returned after a successful `UpdateVolume` API operation, describing
5634
+ # the volume just updated.
5635
+ # @return [Types::Volume]
5636
+ #
5637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolumeResponse AWS API Documentation
5638
+ #
5639
+ class UpdateVolumeResponse < Struct.new(
5640
+ :volume)
5641
+ SENSITIVE = []
5642
+ include Aws::Structure
5643
+ end
5644
+
5645
+ # Describes an Amazon FSx for NetApp ONTAP volume.
5646
+ #
5647
+ # @!attribute [rw] creation_time
5648
+ # The time that the resource was created, in seconds (since
5649
+ # 1970-01-01T00:00:00Z), also known as Unix time.
5650
+ # @return [Time]
5651
+ #
5652
+ # @!attribute [rw] file_system_id
5653
+ # The globally unique ID of the file system, assigned by Amazon FSx.
5654
+ # @return [String]
5655
+ #
5656
+ # @!attribute [rw] lifecycle
5657
+ # The lifecycle status of the volume.
5658
+ #
5659
+ # * `CREATED` - The volume is fully available for use.
5660
+ #
5661
+ # * `CREATING` - Amazon FSx is creating the new volume.
5662
+ #
5663
+ # * `DELETING` - Amazon FSx is deleting an existing volume.
5664
+ #
5665
+ # * `FAILED` - Amazon FSx was unable to create the volume.
5666
+ #
5667
+ # * `MISCONFIGURED` - The volume is in a failed but recoverable state.
5668
+ #
5669
+ # * `PENDING` - Amazon FSx has not started creating the volume.
5670
+ # @return [String]
5671
+ #
5672
+ # @!attribute [rw] name
5673
+ # The name of the volume.
5674
+ # @return [String]
5675
+ #
5676
+ # @!attribute [rw] ontap_configuration
5677
+ # The configuration of an Amazon FSx for NetApp ONTAP volume
5678
+ # @return [Types::OntapVolumeConfiguration]
5679
+ #
5680
+ # @!attribute [rw] resource_arn
5681
+ # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
5682
+ # identify Amazon Web Services resources. We require an ARN when you
5683
+ # need to specify a resource unambiguously across all of Amazon Web
5684
+ # Services. For more information, see [Amazon Resource Names
5685
+ # (ARNs)][1] in the *Amazon Web Services General Reference*.
5686
+ #
5687
+ #
5688
+ #
5689
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
5690
+ # @return [String]
5691
+ #
5692
+ # @!attribute [rw] tags
5693
+ # A list of `Tag` values, with a maximum of 50 elements.
5694
+ # @return [Array<Types::Tag>]
5695
+ #
5696
+ # @!attribute [rw] volume_id
5697
+ # The system-generated, unique ID of the volume.
5698
+ # @return [String]
5699
+ #
5700
+ # @!attribute [rw] volume_type
5701
+ # The type of volume; `ONTAP` is the only valid volume type.
5702
+ # @return [String]
5703
+ #
5704
+ # @!attribute [rw] lifecycle_transition_reason
5705
+ # Describes why the volume lifecycle state changed.
5706
+ # @return [Types::LifecycleTransitionReason]
5707
+ #
5708
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Volume AWS API Documentation
5709
+ #
5710
+ class Volume < Struct.new(
5711
+ :creation_time,
5712
+ :file_system_id,
5713
+ :lifecycle,
5714
+ :name,
5715
+ :ontap_configuration,
5716
+ :resource_arn,
5717
+ :tags,
5718
+ :volume_id,
5719
+ :volume_type,
5720
+ :lifecycle_transition_reason)
5721
+ SENSITIVE = []
5722
+ include Aws::Structure
5723
+ end
5724
+
5725
+ # A filter used to restrict the results of describe calls for Amazon FSx
5726
+ # for NetApp ONTAP volumes. You can use multiple filters to return
5727
+ # results that meet all applied filter requirements.
5728
+ #
5729
+ # @note When making an API call, you may pass VolumeFilter
5730
+ # data as a hash:
5731
+ #
5732
+ # {
5733
+ # name: "file-system-id", # accepts file-system-id, storage-virtual-machine-id
5734
+ # values: ["VolumeFilterValue"],
5735
+ # }
5736
+ #
5737
+ # @!attribute [rw] name
5738
+ # The name for this filter.
5739
+ # @return [String]
5740
+ #
5741
+ # @!attribute [rw] values
5742
+ # The values of the filter. These are all the values for any of the
5743
+ # applied filters.
5744
+ # @return [Array<String>]
5745
+ #
5746
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/VolumeFilter AWS API Documentation
5747
+ #
5748
+ class VolumeFilter < Struct.new(
5749
+ :name,
5750
+ :values)
5751
+ SENSITIVE = []
5752
+ include Aws::Structure
5753
+ end
5754
+
5755
+ # No Amazon FSx for NetApp ONTAP volumes were found based upon the
5756
+ # supplied parameters.
5757
+ #
5758
+ # @!attribute [rw] message
5759
+ # A detailed error message.
5760
+ # @return [String]
5761
+ #
5762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/VolumeNotFound AWS API Documentation
5763
+ #
5764
+ class VolumeNotFound < Struct.new(
5765
+ :message)
5766
+ SENSITIVE = []
5767
+ include Aws::Structure
5768
+ end
5769
+
3920
5770
  # The configuration that Amazon FSx for Windows File Server uses to
3921
5771
  # audit and log user accesses of files, folders, and file shares on the
3922
5772
  # Amazon FSx for Windows File Server file system. For more information,
@@ -3968,8 +5818,9 @@ module Aws::FSx
3968
5818
  # delivery stream must begin with the `aws-fsx` prefix.
3969
5819
  #
3970
5820
  # The destination ARN (either CloudWatch Logs log group or Kinesis
3971
- # Data Firehose delivery stream) must be in the same AWS partition,
3972
- # AWS region, and AWS account as your Amazon FSx file system.
5821
+ # Data Firehose delivery stream) must be in the same Amazon Web
5822
+ # Services partition, Amazon Web Services Region, and Amazon Web
5823
+ # Services account as your Amazon FSx file system.
3973
5824
  # @return [String]
3974
5825
  #
3975
5826
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsAuditLogConfiguration AWS API Documentation
@@ -4036,8 +5887,8 @@ module Aws::FSx
4036
5887
  #
4037
5888
  # * The destination ARN that you provide (either CloudWatch Logs log
4038
5889
  # group or Kinesis Data Firehose delivery stream) must be in the
4039
- # same AWS partition, AWS region, and AWS account as your Amazon FSx
4040
- # file system.
5890
+ # same Amazon Web Services partition, Amazon Web Services Region,
5891
+ # and Amazon Web Services account as your Amazon FSx file system.
4041
5892
  #
4042
5893
  # * The name of the Amazon CloudWatch Logs log group must begin with
4043
5894
  # the `/aws/fsx` prefix. The name of the Amazon Kinesis Data
@@ -4068,13 +5919,14 @@ module Aws::FSx
4068
5919
  # The configuration for this Microsoft Windows file system.
4069
5920
  #
4070
5921
  # @!attribute [rw] active_directory_id
4071
- # The ID for an existing AWS Managed Microsoft Active Directory
4072
- # instance that the file system is joined to.
5922
+ # The ID for an existing Amazon Web Services Managed Microsoft Active
5923
+ # Directory instance that the file system is joined to.
4073
5924
  # @return [String]
4074
5925
  #
4075
5926
  # @!attribute [rw] self_managed_active_directory_configuration
4076
5927
  # The configuration of the self-managed Microsoft Active Directory
4077
- # (AD) directory to which the Windows File Server instance is joined.
5928
+ # (AD) directory to which the Windows File Server or ONTAP storage
5929
+ # virtual machine (SVM) instance is joined.
4078
5930
  # @return [Types::SelfManagedActiveDirectoryAttributes]
4079
5931
  #
4080
5932
  # @!attribute [rw] deployment_type