aws-sdk-fsx 1.41.0 → 1.42.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-fsx/client.rb +1239 -106
- data/lib/aws-sdk-fsx/client_api.rb +486 -1
- data/lib/aws-sdk-fsx/errors.rb +53 -0
- data/lib/aws-sdk-fsx/types.rb +2165 -344
- data/lib/aws-sdk-fsx.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-fsx/errors.rb
CHANGED
@@ -48,12 +48,15 @@ module Aws::FSx
|
|
48
48
|
# * {InvalidRegion}
|
49
49
|
# * {InvalidSourceKmsKey}
|
50
50
|
# * {MissingFileSystemConfiguration}
|
51
|
+
# * {MissingVolumeConfiguration}
|
51
52
|
# * {NotServiceResourceError}
|
52
53
|
# * {ResourceDoesNotSupportTagging}
|
53
54
|
# * {ResourceNotFound}
|
54
55
|
# * {ServiceLimitExceeded}
|
55
56
|
# * {SourceBackupUnavailable}
|
57
|
+
# * {StorageVirtualMachineNotFound}
|
56
58
|
# * {UnsupportedOperation}
|
59
|
+
# * {VolumeNotFound}
|
57
60
|
#
|
58
61
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
59
62
|
# if they are not defined above.
|
@@ -349,6 +352,11 @@ module Aws::FSx
|
|
349
352
|
def invalid_security_group_id
|
350
353
|
@data[:invalid_security_group_id]
|
351
354
|
end
|
355
|
+
|
356
|
+
# @return [String]
|
357
|
+
def invalid_route_table_id
|
358
|
+
@data[:invalid_route_table_id]
|
359
|
+
end
|
352
360
|
end
|
353
361
|
|
354
362
|
class InvalidPerUnitStorageThroughput < ServiceError
|
@@ -411,6 +419,21 @@ module Aws::FSx
|
|
411
419
|
end
|
412
420
|
end
|
413
421
|
|
422
|
+
class MissingVolumeConfiguration < ServiceError
|
423
|
+
|
424
|
+
# @param [Seahorse::Client::RequestContext] context
|
425
|
+
# @param [String] message
|
426
|
+
# @param [Aws::FSx::Types::MissingVolumeConfiguration] data
|
427
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
428
|
+
super(context, message, data)
|
429
|
+
end
|
430
|
+
|
431
|
+
# @return [String]
|
432
|
+
def message
|
433
|
+
@message || @data[:message]
|
434
|
+
end
|
435
|
+
end
|
436
|
+
|
414
437
|
class NotServiceResourceError < ServiceError
|
415
438
|
|
416
439
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -511,6 +534,21 @@ module Aws::FSx
|
|
511
534
|
end
|
512
535
|
end
|
513
536
|
|
537
|
+
class StorageVirtualMachineNotFound < ServiceError
|
538
|
+
|
539
|
+
# @param [Seahorse::Client::RequestContext] context
|
540
|
+
# @param [String] message
|
541
|
+
# @param [Aws::FSx::Types::StorageVirtualMachineNotFound] data
|
542
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
543
|
+
super(context, message, data)
|
544
|
+
end
|
545
|
+
|
546
|
+
# @return [String]
|
547
|
+
def message
|
548
|
+
@message || @data[:message]
|
549
|
+
end
|
550
|
+
end
|
551
|
+
|
514
552
|
class UnsupportedOperation < ServiceError
|
515
553
|
|
516
554
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -526,5 +564,20 @@ module Aws::FSx
|
|
526
564
|
end
|
527
565
|
end
|
528
566
|
|
567
|
+
class VolumeNotFound < ServiceError
|
568
|
+
|
569
|
+
# @param [Seahorse::Client::RequestContext] context
|
570
|
+
# @param [String] message
|
571
|
+
# @param [Aws::FSx::Types::VolumeNotFound] data
|
572
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
573
|
+
super(context, message, data)
|
574
|
+
end
|
575
|
+
|
576
|
+
# @return [String]
|
577
|
+
def message
|
578
|
+
@message || @data[:message]
|
579
|
+
end
|
580
|
+
end
|
581
|
+
|
529
582
|
end
|
530
583
|
end
|
data/lib/aws-sdk-fsx/types.rb
CHANGED
@@ -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
|
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
|
28
|
-
# resource unambiguously across all of
|
29
|
-
#
|
30
|
-
# *
|
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
|
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
|
264
|
-
#
|
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
|
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
|
370
|
-
#
|
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
|
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
|
660
|
-
#
|
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
|
673
|
-
# which the backup is being copied.
|
674
|
-
# must be in the same
|
675
|
-
#
|
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
|
681
|
-
#
|
682
|
-
#
|
683
|
-
# systems at rest.
|
684
|
-
# managed key is used. The Amazon FSx for Lustre
|
685
|
-
# `SCRATCH_2` file systems are always encrypted at
|
686
|
-
# FSx managed keys. For more information, see
|
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
|
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",
|
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
|
759
|
-
#
|
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
|
853
|
-
#
|
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.
|
@@ -950,8 +973,8 @@ module Aws::FSx
|
|
950
973
|
# @!attribute [rw] client_request_token
|
951
974
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
952
975
|
# idempotent creation. This string is automatically filled on your
|
953
|
-
# behalf when you use the
|
954
|
-
#
|
976
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon
|
977
|
+
# Web Services SDK.
|
955
978
|
#
|
956
979
|
# **A suitable default value is auto-generated.** You should normally
|
957
980
|
# not need to pass this option.
|
@@ -1015,14 +1038,14 @@ module Aws::FSx
|
|
1015
1038
|
# @return [String]
|
1016
1039
|
#
|
1017
1040
|
# @!attribute [rw] kms_key_id
|
1018
|
-
# The ID of the
|
1019
|
-
#
|
1020
|
-
#
|
1021
|
-
# systems at rest.
|
1022
|
-
# managed key is used. The Amazon FSx for Lustre
|
1023
|
-
# `SCRATCH_2` file systems are always encrypted at
|
1024
|
-
# FSx managed keys. For more information, see
|
1025
|
-
# Key Management Service API Reference*.
|
1041
|
+
# The ID of the Key Management Service (KMS) key used to encrypt the
|
1042
|
+
# file system's data for Amazon FSx for Windows File Server file
|
1043
|
+
# systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
|
1044
|
+
# for Lustre `PERSISTENT_1` file systems at rest. If not specified,
|
1045
|
+
# the Amazon FSx managed key is used. The Amazon FSx for Lustre
|
1046
|
+
# `SCRATCH_1` and `SCRATCH_2` file systems are always encrypted at
|
1047
|
+
# rest using Amazon FSx managed keys. For more information, see
|
1048
|
+
# [Encrypt][1] in the *Key Management Service API Reference*.
|
1026
1049
|
#
|
1027
1050
|
#
|
1028
1051
|
#
|
@@ -1146,8 +1169,8 @@ module Aws::FSx
|
|
1146
1169
|
#
|
1147
1170
|
# Encryption of data in-transit for `SCRATCH_2` and `PERSISTENT_1`
|
1148
1171
|
# deployment types is supported when accessed from supported instance
|
1149
|
-
# types in supported
|
1150
|
-
# Transit][3].
|
1172
|
+
# types in supported Amazon Web Services Regions. To learn more,
|
1173
|
+
# [Encrypting Data in Transit][3].
|
1151
1174
|
#
|
1152
1175
|
#
|
1153
1176
|
#
|
@@ -1275,6 +1298,117 @@ module Aws::FSx
|
|
1275
1298
|
include Aws::Structure
|
1276
1299
|
end
|
1277
1300
|
|
1301
|
+
# The ONTAP configuration properties of the FSx for NetApp ONTAP file
|
1302
|
+
# system that you are creating.
|
1303
|
+
#
|
1304
|
+
# @note When making an API call, you may pass CreateFileSystemOntapConfiguration
|
1305
|
+
# data as a hash:
|
1306
|
+
#
|
1307
|
+
# {
|
1308
|
+
# automatic_backup_retention_days: 1,
|
1309
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
1310
|
+
# deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1
|
1311
|
+
# endpoint_ip_address_range: "IpAddressRange",
|
1312
|
+
# fsx_admin_password: "AdminPassword",
|
1313
|
+
# disk_iops_configuration: {
|
1314
|
+
# mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
|
1315
|
+
# iops: 1,
|
1316
|
+
# },
|
1317
|
+
# preferred_subnet_id: "SubnetId",
|
1318
|
+
# route_table_ids: ["RouteTableId"],
|
1319
|
+
# throughput_capacity: 1, # required
|
1320
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
1321
|
+
# }
|
1322
|
+
#
|
1323
|
+
# @!attribute [rw] automatic_backup_retention_days
|
1324
|
+
# The number of days to retain automatic backups. Setting this to 0
|
1325
|
+
# disables automatic backups. You can retain automatic backups for a
|
1326
|
+
# maximum of 90 days. The default is 0.
|
1327
|
+
# @return [Integer]
|
1328
|
+
#
|
1329
|
+
# @!attribute [rw] daily_automatic_backup_start_time
|
1330
|
+
# A recurring daily time, in the format `HH:MM`. `HH` is the
|
1331
|
+
# zero-padded hour of the day (0-23), and `MM` is the zero-padded
|
1332
|
+
# minute of the hour. For example, `05:00` specifies 5 AM daily.
|
1333
|
+
# @return [String]
|
1334
|
+
#
|
1335
|
+
# @!attribute [rw] deployment_type
|
1336
|
+
# Specifies the ONTAP file system deployment type to use in creating
|
1337
|
+
# the file system.
|
1338
|
+
# @return [String]
|
1339
|
+
#
|
1340
|
+
# @!attribute [rw] endpoint_ip_address_range
|
1341
|
+
# Specifies the IP address range in which the endpoints to access your
|
1342
|
+
# file system will be created. By default, Amazon FSx selects an
|
1343
|
+
# unused IP address range for you from the 198.19.* range.
|
1344
|
+
# @return [String]
|
1345
|
+
#
|
1346
|
+
# @!attribute [rw] fsx_admin_password
|
1347
|
+
# The ONTAP administrative password for the `fsxadmin` user that you
|
1348
|
+
# can use to administer your file system using the ONTAP CLI and REST
|
1349
|
+
# API.
|
1350
|
+
# @return [String]
|
1351
|
+
#
|
1352
|
+
# @!attribute [rw] disk_iops_configuration
|
1353
|
+
# The SSD IOPS configuration for the Amazon FSx for NetApp ONTAP file
|
1354
|
+
# system.
|
1355
|
+
# @return [Types::DiskIopsConfiguration]
|
1356
|
+
#
|
1357
|
+
# @!attribute [rw] preferred_subnet_id
|
1358
|
+
# The ID for a subnet. A *subnet* is a range of IP addresses in your
|
1359
|
+
# virtual private cloud (VPC). For more information, see [VPC and
|
1360
|
+
# Subnets][1] in the *Amazon VPC User Guide.*
|
1361
|
+
#
|
1362
|
+
#
|
1363
|
+
#
|
1364
|
+
# [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html
|
1365
|
+
# @return [String]
|
1366
|
+
#
|
1367
|
+
# @!attribute [rw] route_table_ids
|
1368
|
+
# Specifies the VPC route tables in which your file system's
|
1369
|
+
# endpoints will be created. You should specify all VPC route tables
|
1370
|
+
# associated with the subnets in which your clients are located. By
|
1371
|
+
# default, Amazon FSx selects your VPC's default route table.
|
1372
|
+
# @return [Array<String>]
|
1373
|
+
#
|
1374
|
+
# @!attribute [rw] throughput_capacity
|
1375
|
+
# Sustained throughput of an Amazon FSx file system in MBps.
|
1376
|
+
# @return [Integer]
|
1377
|
+
#
|
1378
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
1379
|
+
# A recurring weekly time, in the format `D:HH:MM`.
|
1380
|
+
#
|
1381
|
+
# `D` is the day of the week, for which 1 represents Monday and 7
|
1382
|
+
# represents Sunday. For further details, see [the ISO-8601 spec as
|
1383
|
+
# described on Wikipedia][1].
|
1384
|
+
#
|
1385
|
+
# `HH` is the zero-padded hour of the day (0-23), and `MM` is the
|
1386
|
+
# zero-padded minute of the hour.
|
1387
|
+
#
|
1388
|
+
# For example, `1:05:00` specifies maintenance at 5 AM Monday.
|
1389
|
+
#
|
1390
|
+
#
|
1391
|
+
#
|
1392
|
+
# [1]: https://en.wikipedia.org/wiki/ISO_week_date
|
1393
|
+
# @return [String]
|
1394
|
+
#
|
1395
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemOntapConfiguration AWS API Documentation
|
1396
|
+
#
|
1397
|
+
class CreateFileSystemOntapConfiguration < Struct.new(
|
1398
|
+
:automatic_backup_retention_days,
|
1399
|
+
:daily_automatic_backup_start_time,
|
1400
|
+
:deployment_type,
|
1401
|
+
:endpoint_ip_address_range,
|
1402
|
+
:fsx_admin_password,
|
1403
|
+
:disk_iops_configuration,
|
1404
|
+
:preferred_subnet_id,
|
1405
|
+
:route_table_ids,
|
1406
|
+
:throughput_capacity,
|
1407
|
+
:weekly_maintenance_start_time)
|
1408
|
+
SENSITIVE = [:fsx_admin_password]
|
1409
|
+
include Aws::Structure
|
1410
|
+
end
|
1411
|
+
|
1278
1412
|
# The request object used to create a new Amazon FSx file system.
|
1279
1413
|
#
|
1280
1414
|
# @note When making an API call, you may pass CreateFileSystemRequest
|
@@ -1282,7 +1416,7 @@ module Aws::FSx
|
|
1282
1416
|
#
|
1283
1417
|
# {
|
1284
1418
|
# client_request_token: "ClientRequestToken",
|
1285
|
-
# file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE
|
1419
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE, ONTAP
|
1286
1420
|
# storage_capacity: 1, # required
|
1287
1421
|
# storage_type: "SSD", # accepts SSD, HDD
|
1288
1422
|
# subnet_ids: ["SubnetId"], # required
|
@@ -1332,21 +1466,36 @@ module Aws::FSx
|
|
1332
1466
|
# drive_cache_type: "NONE", # accepts NONE, READ
|
1333
1467
|
# data_compression_type: "NONE", # accepts NONE, LZ4
|
1334
1468
|
# },
|
1469
|
+
# ontap_configuration: {
|
1470
|
+
# automatic_backup_retention_days: 1,
|
1471
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
1472
|
+
# deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1
|
1473
|
+
# endpoint_ip_address_range: "IpAddressRange",
|
1474
|
+
# fsx_admin_password: "AdminPassword",
|
1475
|
+
# disk_iops_configuration: {
|
1476
|
+
# mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
|
1477
|
+
# iops: 1,
|
1478
|
+
# },
|
1479
|
+
# preferred_subnet_id: "SubnetId",
|
1480
|
+
# route_table_ids: ["RouteTableId"],
|
1481
|
+
# throughput_capacity: 1, # required
|
1482
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
1483
|
+
# },
|
1335
1484
|
# }
|
1336
1485
|
#
|
1337
1486
|
# @!attribute [rw] client_request_token
|
1338
1487
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
1339
1488
|
# idempotent creation. This string is automatically filled on your
|
1340
|
-
# behalf when you use the
|
1341
|
-
#
|
1489
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon
|
1490
|
+
# Web Services SDK.
|
1342
1491
|
#
|
1343
1492
|
# **A suitable default value is auto-generated.** You should normally
|
1344
1493
|
# not need to pass this option.
|
1345
1494
|
# @return [String]
|
1346
1495
|
#
|
1347
1496
|
# @!attribute [rw] file_system_type
|
1348
|
-
# The type of Amazon FSx file system to create
|
1349
|
-
# `LUSTRE`.
|
1497
|
+
# The type of Amazon FSx file system to create. Valid values are
|
1498
|
+
# `WINDOWS`, `LUSTRE`, and `ONTAP`.
|
1350
1499
|
# @return [String]
|
1351
1500
|
#
|
1352
1501
|
# @!attribute [rw] storage_capacity
|
@@ -1371,6 +1520,12 @@ module Aws::FSx
|
|
1371
1520
|
#
|
1372
1521
|
# * If `StorageType=HDD`, valid values are 2000 GiB - 65,536 GiB (64
|
1373
1522
|
# TiB).
|
1523
|
+
#
|
1524
|
+
# For ONTAP file systems:
|
1525
|
+
#
|
1526
|
+
# * Valid values are 1024 GiB - 196,608 GiB (192 TiB).
|
1527
|
+
#
|
1528
|
+
# ^
|
1374
1529
|
# @return [Integer]
|
1375
1530
|
#
|
1376
1531
|
# @!attribute [rw] storage_type
|
@@ -1378,7 +1533,7 @@ module Aws::FSx
|
|
1378
1533
|
# values are `SSD` and `HDD`.
|
1379
1534
|
#
|
1380
1535
|
# * Set to `SSD` to use solid state drive storage. SSD is supported on
|
1381
|
-
# all Windows and
|
1536
|
+
# all Windows, Lustre, and ONTAP deployment types.
|
1382
1537
|
#
|
1383
1538
|
# * Set to `HDD` to use hard disk drive storage. HDD is supported on
|
1384
1539
|
# `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment
|
@@ -1396,13 +1551,15 @@ module Aws::FSx
|
|
1396
1551
|
#
|
1397
1552
|
# @!attribute [rw] subnet_ids
|
1398
1553
|
# Specifies the IDs of the subnets that the file system will be
|
1399
|
-
# accessible from. For Windows `MULTI_AZ_1` file system
|
1400
|
-
# types, provide exactly two subnet IDs, one for the
|
1401
|
-
# server and one for the standby file server. You
|
1402
|
-
# subnets as the preferred subnet using the
|
1403
|
-
#
|
1404
|
-
#
|
1405
|
-
# systems][1]
|
1554
|
+
# accessible from. For Windows and ONTAP `MULTI_AZ_1` file system
|
1555
|
+
# deployment types, provide exactly two subnet IDs, one for the
|
1556
|
+
# preferred file server and one for the standby file server. You
|
1557
|
+
# specify one of these subnets as the preferred subnet using the
|
1558
|
+
# `WindowsConfiguration > PreferredSubnetID` or `OntapConfiguration >
|
1559
|
+
# PreferredSubnetID` properties. For more information, see [
|
1560
|
+
# Availability and durability: Single-AZ and Multi-AZ file systems][1]
|
1561
|
+
# in the *Amazon FSx for Windows User Guide* and [ Availability and
|
1562
|
+
# durability][2] in the *Amazon FSx for ONTAP User Guide*.
|
1406
1563
|
#
|
1407
1564
|
# For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment
|
1408
1565
|
# types and Lustre file systems, provide exactly one subnet ID. The
|
@@ -1411,6 +1568,7 @@ module Aws::FSx
|
|
1411
1568
|
#
|
1412
1569
|
#
|
1413
1570
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html
|
1571
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html
|
1414
1572
|
# @return [Array<String>]
|
1415
1573
|
#
|
1416
1574
|
# @!attribute [rw] security_group_ids
|
@@ -1425,14 +1583,14 @@ module Aws::FSx
|
|
1425
1583
|
# @return [Array<Types::Tag>]
|
1426
1584
|
#
|
1427
1585
|
# @!attribute [rw] kms_key_id
|
1428
|
-
# The ID of the
|
1429
|
-
#
|
1430
|
-
#
|
1431
|
-
# systems at rest.
|
1432
|
-
# managed key is used. The Amazon FSx for Lustre
|
1433
|
-
# `SCRATCH_2` file systems are always encrypted at
|
1434
|
-
# FSx managed keys. For more information, see
|
1435
|
-
# Key Management Service API Reference*.
|
1586
|
+
# The ID of the Key Management Service (KMS) key used to encrypt the
|
1587
|
+
# file system's data for Amazon FSx for Windows File Server file
|
1588
|
+
# systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx
|
1589
|
+
# for Lustre `PERSISTENT_1` file systems at rest. If not specified,
|
1590
|
+
# the Amazon FSx managed key is used. The Amazon FSx for Lustre
|
1591
|
+
# `SCRATCH_1` and `SCRATCH_2` file systems are always encrypted at
|
1592
|
+
# rest using Amazon FSx managed keys. For more information, see
|
1593
|
+
# [Encrypt][1] in the *Key Management Service API Reference*.
|
1436
1594
|
#
|
1437
1595
|
#
|
1438
1596
|
#
|
@@ -1448,6 +1606,11 @@ module Aws::FSx
|
|
1448
1606
|
# The Lustre configuration for the file system being created.
|
1449
1607
|
# @return [Types::CreateFileSystemLustreConfiguration]
|
1450
1608
|
#
|
1609
|
+
# @!attribute [rw] ontap_configuration
|
1610
|
+
# The ONTAP configuration properties of the FSx for NetApp ONTAP file
|
1611
|
+
# system that you are creating.
|
1612
|
+
# @return [Types::CreateFileSystemOntapConfiguration]
|
1613
|
+
#
|
1451
1614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemRequest AWS API Documentation
|
1452
1615
|
#
|
1453
1616
|
class CreateFileSystemRequest < Struct.new(
|
@@ -1460,7 +1623,8 @@ module Aws::FSx
|
|
1460
1623
|
:tags,
|
1461
1624
|
:kms_key_id,
|
1462
1625
|
:windows_configuration,
|
1463
|
-
:lustre_configuration
|
1626
|
+
:lustre_configuration,
|
1627
|
+
:ontap_configuration)
|
1464
1628
|
SENSITIVE = []
|
1465
1629
|
include Aws::Structure
|
1466
1630
|
end
|
@@ -1511,20 +1675,23 @@ module Aws::FSx
|
|
1511
1675
|
# }
|
1512
1676
|
#
|
1513
1677
|
# @!attribute [rw] active_directory_id
|
1514
|
-
# The ID for an existing
|
1515
|
-
# instance that the file system should join when it's
|
1678
|
+
# The ID for an existing Amazon Web Services Managed Microsoft Active
|
1679
|
+
# Directory (AD) instance that the file system should join when it's
|
1680
|
+
# created.
|
1516
1681
|
# @return [String]
|
1517
1682
|
#
|
1518
1683
|
# @!attribute [rw] self_managed_active_directory_configuration
|
1519
|
-
# The configuration that Amazon FSx uses to join
|
1520
|
-
# Server
|
1521
|
-
#
|
1522
|
-
#
|
1523
|
-
# Directory][1]
|
1684
|
+
# The configuration that Amazon FSx uses to join a Amazon FSx for
|
1685
|
+
# Windows File Server file system or an ONTAP storage virtual machine
|
1686
|
+
# (SVM) to a self-managed (including on-premises) Microsoft Active
|
1687
|
+
# Directory (AD) directory. For more information, see [ Using Amazon
|
1688
|
+
# FSx with your self-managed Microsoft Active Directory][1] or
|
1689
|
+
# [Managing SVMs][2].
|
1524
1690
|
#
|
1525
1691
|
#
|
1526
1692
|
#
|
1527
1693
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
|
1694
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
|
1528
1695
|
# @return [Types::SelfManagedActiveDirectoryConfiguration]
|
1529
1696
|
#
|
1530
1697
|
# @!attribute [rw] deployment_type
|
@@ -1534,8 +1701,9 @@ module Aws::FSx
|
|
1534
1701
|
# * `MULTI_AZ_1` - Deploys a high availability file system that is
|
1535
1702
|
# configured for Multi-AZ redundancy to tolerate temporary
|
1536
1703
|
# Availability Zone (AZ) unavailability. You can only deploy a
|
1537
|
-
# Multi-AZ file system in
|
1538
|
-
# Availability Zones. Also supports HDD storage
|
1704
|
+
# Multi-AZ file system in Amazon Web Services Regions that have a
|
1705
|
+
# minimum of three Availability Zones. Also supports HDD storage
|
1706
|
+
# type
|
1539
1707
|
#
|
1540
1708
|
# * `SINGLE_AZ_1` - (Default) Choose to deploy a file system that is
|
1541
1709
|
# configured for single AZ redundancy.
|
@@ -1555,10 +1723,10 @@ module Aws::FSx
|
|
1555
1723
|
# @!attribute [rw] preferred_subnet_id
|
1556
1724
|
# Required when `DeploymentType` is set to `MULTI_AZ_1`. This
|
1557
1725
|
# specifies the subnet in which you want the preferred file server to
|
1558
|
-
# be located. For in-
|
1559
|
-
# your clients in the same Availability Zone (AZ) as
|
1560
|
-
# file server to reduce cross-AZ data transfer costs
|
1561
|
-
# latency.
|
1726
|
+
# be located. For in-Amazon Web Services applications, we recommend
|
1727
|
+
# that you launch your clients in the same Availability Zone (AZ) as
|
1728
|
+
# your preferred file server to reduce cross-AZ data transfer costs
|
1729
|
+
# and minimize latency.
|
1562
1730
|
# @return [String]
|
1563
1731
|
#
|
1564
1732
|
# @!attribute [rw] throughput_capacity
|
@@ -1659,137 +1827,520 @@ module Aws::FSx
|
|
1659
1827
|
include Aws::Structure
|
1660
1828
|
end
|
1661
1829
|
|
1662
|
-
#
|
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:
|
1830
|
+
# Specifies the configuration of the ONTAP volume that you are creating.
|
1669
1831
|
#
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
# The data repository is unavailable.
|
1832
|
+
# @note When making an API call, you may pass CreateOntapVolumeConfiguration
|
1833
|
+
# data as a hash:
|
1673
1834
|
#
|
1674
|
-
#
|
1835
|
+
# {
|
1836
|
+
# junction_path: "JunctionPath", # required
|
1837
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
1838
|
+
# size_in_megabytes: 1, # required
|
1839
|
+
# storage_efficiency_enabled: false, # required
|
1840
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
1841
|
+
# tiering_policy: {
|
1842
|
+
# cooling_period: 1,
|
1843
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
1844
|
+
# },
|
1845
|
+
# }
|
1675
1846
|
#
|
1676
|
-
#
|
1677
|
-
#
|
1678
|
-
#
|
1679
|
-
#
|
1847
|
+
# @!attribute [rw] junction_path
|
1848
|
+
# Specifies the location in the SVM's namespace where the volume is
|
1849
|
+
# mounted. The `JunctionPath` must have a leading forward slash, such
|
1850
|
+
# as `/vol3`.
|
1851
|
+
# @return [String]
|
1680
1852
|
#
|
1681
|
-
#
|
1682
|
-
#
|
1853
|
+
# @!attribute [rw] security_style
|
1854
|
+
# The security style for the volume. Specify one of the following
|
1855
|
+
# values:
|
1683
1856
|
#
|
1857
|
+
# * `UNIX` if the file system is managed by a UNIX administrator, the
|
1858
|
+
# majority of users are NFS clients, and an application accessing
|
1859
|
+
# the data uses a UNIX user as the service account. `UNIX` is the
|
1860
|
+
# default.
|
1684
1861
|
#
|
1862
|
+
# * `NTFS` if the file system is managed by a Windows administrator,
|
1863
|
+
# the majority of users are SMB clients, and an application
|
1864
|
+
# accessing the data uses a Windows user as the service account.
|
1685
1865
|
#
|
1686
|
-
#
|
1866
|
+
# * `MIXED` if the file system is managed by both UNIX and Windows
|
1867
|
+
# administrators and users consist of both NFS and SMB clients.
|
1687
1868
|
# @return [String]
|
1688
1869
|
#
|
1689
|
-
# @!attribute [rw]
|
1690
|
-
#
|
1691
|
-
#
|
1692
|
-
#
|
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]
|
1870
|
+
# @!attribute [rw] size_in_megabytes
|
1871
|
+
# Specifies the size of the volume, in megabytes (MB), that you are
|
1872
|
+
# creating.
|
1873
|
+
# @return [Integer]
|
1696
1874
|
#
|
1697
|
-
# @!attribute [rw]
|
1698
|
-
#
|
1699
|
-
#
|
1875
|
+
# @!attribute [rw] storage_efficiency_enabled
|
1876
|
+
# Set to true to enable deduplication, compression, and compaction
|
1877
|
+
# storage efficiency features on the volume.
|
1878
|
+
# @return [Boolean]
|
1879
|
+
#
|
1880
|
+
# @!attribute [rw] storage_virtual_machine_id
|
1881
|
+
# Specifies the ONTAP SVM in which to create the volume.
|
1700
1882
|
# @return [String]
|
1701
1883
|
#
|
1702
|
-
# @!attribute [rw]
|
1703
|
-
#
|
1704
|
-
#
|
1705
|
-
# a
|
1706
|
-
#
|
1707
|
-
#
|
1884
|
+
# @!attribute [rw] tiering_policy
|
1885
|
+
# Describes the data tiering policy for an ONTAP volume. When enabled,
|
1886
|
+
# Amazon FSx for ONTAP's intelligent tiering automatically
|
1887
|
+
# transitions a volume's data between the file system's primary
|
1888
|
+
# storage and capacity pool storage based on your access patterns.
|
1889
|
+
# @return [Types::TieringPolicy]
|
1708
1890
|
#
|
1709
|
-
#
|
1710
|
-
# 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5
|
1711
|
-
# TB.
|
1712
|
-
# @return [Integer]
|
1891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOntapVolumeConfiguration AWS API Documentation
|
1713
1892
|
#
|
1714
|
-
|
1715
|
-
|
1716
|
-
|
1717
|
-
|
1718
|
-
|
1719
|
-
|
1893
|
+
class CreateOntapVolumeConfiguration < Struct.new(
|
1894
|
+
:junction_path,
|
1895
|
+
:security_style,
|
1896
|
+
:size_in_megabytes,
|
1897
|
+
:storage_efficiency_enabled,
|
1898
|
+
:storage_virtual_machine_id,
|
1899
|
+
:tiering_policy)
|
1900
|
+
SENSITIVE = []
|
1901
|
+
include Aws::Structure
|
1902
|
+
end
|
1903
|
+
|
1904
|
+
# @note When making an API call, you may pass CreateStorageVirtualMachineRequest
|
1905
|
+
# data as a hash:
|
1720
1906
|
#
|
1721
|
-
#
|
1722
|
-
#
|
1723
|
-
#
|
1724
|
-
#
|
1907
|
+
# {
|
1908
|
+
# active_directory_configuration: {
|
1909
|
+
# net_bios_name: "NetBiosAlias", # required
|
1910
|
+
# self_managed_active_directory_configuration: {
|
1911
|
+
# domain_name: "ActiveDirectoryFullyQualifiedName", # required
|
1912
|
+
# organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
|
1913
|
+
# file_system_administrators_group: "FileSystemAdministratorsGroupName",
|
1914
|
+
# user_name: "DirectoryUserName", # required
|
1915
|
+
# password: "DirectoryPassword", # required
|
1916
|
+
# dns_ips: ["IpAddress"], # required
|
1917
|
+
# },
|
1918
|
+
# },
|
1919
|
+
# client_request_token: "ClientRequestToken",
|
1920
|
+
# file_system_id: "FileSystemId", # required
|
1921
|
+
# name: "StorageVirtualMachineName", # required
|
1922
|
+
# svm_admin_password: "AdminPassword",
|
1923
|
+
# tags: [
|
1924
|
+
# {
|
1925
|
+
# key: "TagKey", # required
|
1926
|
+
# value: "TagValue", # required
|
1927
|
+
# },
|
1928
|
+
# ],
|
1929
|
+
# root_volume_security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
1930
|
+
# }
|
1725
1931
|
#
|
1726
|
-
#
|
1727
|
-
#
|
1728
|
-
#
|
1932
|
+
# @!attribute [rw] active_directory_configuration
|
1933
|
+
# Describes the self-managed Microsoft Active Directory to which you
|
1934
|
+
# want to join the SVM. Joining an Active Directory provides user
|
1935
|
+
# authentication and access control for SMB clients, including
|
1936
|
+
# Microsoft Windows and macOS client accessing the file system.
|
1937
|
+
# @return [Types::CreateSvmActiveDirectoryConfiguration]
|
1729
1938
|
#
|
1730
|
-
#
|
1731
|
-
#
|
1732
|
-
#
|
1733
|
-
#
|
1939
|
+
# @!attribute [rw] client_request_token
|
1940
|
+
# (Optional) An idempotency token for resource creation, in a string
|
1941
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
1942
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
1943
|
+
# Amazon Web Services SDK.
|
1734
1944
|
#
|
1735
|
-
#
|
1736
|
-
#
|
1945
|
+
# **A suitable default value is auto-generated.** You should normally
|
1946
|
+
# not need to pass this option.
|
1947
|
+
# @return [String]
|
1737
1948
|
#
|
1949
|
+
# @!attribute [rw] file_system_id
|
1950
|
+
# The globally unique ID of the file system, assigned by Amazon FSx.
|
1951
|
+
# @return [String]
|
1738
1952
|
#
|
1953
|
+
# @!attribute [rw] name
|
1954
|
+
# The name of the SVM.
|
1955
|
+
# @return [String]
|
1739
1956
|
#
|
1740
|
-
#
|
1957
|
+
# @!attribute [rw] svm_admin_password
|
1958
|
+
# The password to use when managing the SVM using the NetApp ONTAP CLI
|
1959
|
+
# or REST API. If you do not specify a password, you can still use the
|
1960
|
+
# file system's `fsxadmin` user to manage the SVM.
|
1741
1961
|
# @return [String]
|
1742
1962
|
#
|
1743
|
-
# @!attribute [rw]
|
1744
|
-
#
|
1745
|
-
#
|
1746
|
-
# @return [Types::DataRepositoryFailureDetails]
|
1963
|
+
# @!attribute [rw] tags
|
1964
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
1965
|
+
# @return [Array<Types::Tag>]
|
1747
1966
|
#
|
1748
|
-
#
|
1967
|
+
# @!attribute [rw] root_volume_security_style
|
1968
|
+
# The security style of the root volume of the SVM. Specify one of the
|
1969
|
+
# following values:
|
1749
1970
|
#
|
1750
|
-
|
1751
|
-
|
1752
|
-
|
1753
|
-
|
1754
|
-
|
1755
|
-
|
1756
|
-
|
1757
|
-
|
1971
|
+
# * `UNIX` if the file system is managed by a UNIX administrator, the
|
1972
|
+
# majority of users are NFS clients, and an application accessing
|
1973
|
+
# the data uses a UNIX user as the service account.
|
1974
|
+
#
|
1975
|
+
# * `NTFS` if the file system is managed by a Windows administrator,
|
1976
|
+
# the majority of users are SMB clients, and an application
|
1977
|
+
# accessing the data uses a Windows user as the service account.
|
1978
|
+
#
|
1979
|
+
# * `MIXED` if the file system is managed by both UNIX and Windows
|
1980
|
+
# administrators and users consist of both NFS and SMB clients.
|
1981
|
+
# @return [String]
|
1982
|
+
#
|
1983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateStorageVirtualMachineRequest AWS API Documentation
|
1984
|
+
#
|
1985
|
+
class CreateStorageVirtualMachineRequest < Struct.new(
|
1986
|
+
:active_directory_configuration,
|
1987
|
+
:client_request_token,
|
1988
|
+
:file_system_id,
|
1989
|
+
:name,
|
1990
|
+
:svm_admin_password,
|
1991
|
+
:tags,
|
1992
|
+
:root_volume_security_style)
|
1993
|
+
SENSITIVE = [:svm_admin_password]
|
1758
1994
|
include Aws::Structure
|
1759
1995
|
end
|
1760
1996
|
|
1761
|
-
#
|
1762
|
-
#
|
1997
|
+
# @!attribute [rw] storage_virtual_machine
|
1998
|
+
# Returned after a successful `CreateStorageVirtualMachine` operation;
|
1999
|
+
# describes the SVM just created.
|
2000
|
+
# @return [Types::StorageVirtualMachine]
|
1763
2001
|
#
|
1764
|
-
#
|
1765
|
-
# A detailed error message.
|
1766
|
-
# @return [String]
|
1767
|
-
#
|
1768
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryFailureDetails AWS API Documentation
|
2002
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateStorageVirtualMachineResponse AWS API Documentation
|
1769
2003
|
#
|
1770
|
-
class
|
1771
|
-
:
|
2004
|
+
class CreateStorageVirtualMachineResponse < Struct.new(
|
2005
|
+
:storage_virtual_machine)
|
1772
2006
|
SENSITIVE = []
|
1773
2007
|
include Aws::Structure
|
1774
2008
|
end
|
1775
2009
|
|
1776
|
-
#
|
1777
|
-
#
|
1778
|
-
#
|
2010
|
+
# The configuration that Amazon FSx uses to join the ONTAP storage
|
2011
|
+
# virtual machine (SVM) to your self-managed (including on-premises)
|
2012
|
+
# Microsoft Active Directory (AD) directory.
|
1779
2013
|
#
|
1780
|
-
#
|
1781
|
-
#
|
1782
|
-
#
|
2014
|
+
# @note When making an API call, you may pass CreateSvmActiveDirectoryConfiguration
|
2015
|
+
# data as a hash:
|
2016
|
+
#
|
2017
|
+
# {
|
2018
|
+
# net_bios_name: "NetBiosAlias", # required
|
2019
|
+
# self_managed_active_directory_configuration: {
|
2020
|
+
# domain_name: "ActiveDirectoryFullyQualifiedName", # required
|
2021
|
+
# organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
|
2022
|
+
# file_system_administrators_group: "FileSystemAdministratorsGroupName",
|
2023
|
+
# user_name: "DirectoryUserName", # required
|
2024
|
+
# password: "DirectoryPassword", # required
|
2025
|
+
# dns_ips: ["IpAddress"], # required
|
2026
|
+
# },
|
2027
|
+
# }
|
2028
|
+
#
|
2029
|
+
# @!attribute [rw] net_bios_name
|
2030
|
+
# The NetBIOS name of the Active Directory computer object that will
|
2031
|
+
# be created for your SVM.
|
1783
2032
|
# @return [String]
|
1784
2033
|
#
|
1785
|
-
# @!attribute [rw]
|
1786
|
-
# The
|
2034
|
+
# @!attribute [rw] self_managed_active_directory_configuration
|
2035
|
+
# The configuration that Amazon FSx uses to join a Amazon FSx for
|
2036
|
+
# Windows File Server file system or an ONTAP storage virtual machine
|
2037
|
+
# (SVM) to a self-managed (including on-premises) Microsoft Active
|
2038
|
+
# Directory (AD) directory. For more information, see [ Using Amazon
|
2039
|
+
# FSx with your self-managed Microsoft Active Directory][1] or
|
2040
|
+
# [Managing SVMs][2].
|
1787
2041
|
#
|
1788
|
-
# * `PENDING` - Amazon FSx has not started the task.
|
1789
2042
|
#
|
1790
|
-
# * `EXECUTING` - Amazon FSx is processing the task.
|
1791
2043
|
#
|
1792
|
-
#
|
2044
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
|
2045
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
|
2046
|
+
# @return [Types::SelfManagedActiveDirectoryConfiguration]
|
2047
|
+
#
|
2048
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateSvmActiveDirectoryConfiguration AWS API Documentation
|
2049
|
+
#
|
2050
|
+
class CreateSvmActiveDirectoryConfiguration < Struct.new(
|
2051
|
+
:net_bios_name,
|
2052
|
+
:self_managed_active_directory_configuration)
|
2053
|
+
SENSITIVE = []
|
2054
|
+
include Aws::Structure
|
2055
|
+
end
|
2056
|
+
|
2057
|
+
# @note When making an API call, you may pass CreateVolumeFromBackupRequest
|
2058
|
+
# data as a hash:
|
2059
|
+
#
|
2060
|
+
# {
|
2061
|
+
# backup_id: "BackupId", # required
|
2062
|
+
# client_request_token: "ClientRequestToken",
|
2063
|
+
# name: "VolumeName", # required
|
2064
|
+
# ontap_configuration: {
|
2065
|
+
# junction_path: "JunctionPath", # required
|
2066
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
2067
|
+
# size_in_megabytes: 1, # required
|
2068
|
+
# storage_efficiency_enabled: false, # required
|
2069
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
2070
|
+
# tiering_policy: {
|
2071
|
+
# cooling_period: 1,
|
2072
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
2073
|
+
# },
|
2074
|
+
# },
|
2075
|
+
# tags: [
|
2076
|
+
# {
|
2077
|
+
# key: "TagKey", # required
|
2078
|
+
# value: "TagValue", # required
|
2079
|
+
# },
|
2080
|
+
# ],
|
2081
|
+
# }
|
2082
|
+
#
|
2083
|
+
# @!attribute [rw] backup_id
|
2084
|
+
# The ID of the source backup. Specifies the backup you are copying.
|
2085
|
+
# @return [String]
|
2086
|
+
#
|
2087
|
+
# @!attribute [rw] client_request_token
|
2088
|
+
# (Optional) An idempotency token for resource creation, in a string
|
2089
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
2090
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
2091
|
+
# Amazon Web Services SDK.
|
2092
|
+
#
|
2093
|
+
# **A suitable default value is auto-generated.** You should normally
|
2094
|
+
# not need to pass this option.
|
2095
|
+
# @return [String]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] name
|
2098
|
+
# The name of the new volume you're creating.
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] ontap_configuration
|
2102
|
+
# Specifies the configuration of the ONTAP volume that you are
|
2103
|
+
# creating.
|
2104
|
+
# @return [Types::CreateOntapVolumeConfiguration]
|
2105
|
+
#
|
2106
|
+
# @!attribute [rw] tags
|
2107
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
2108
|
+
# @return [Array<Types::Tag>]
|
2109
|
+
#
|
2110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeFromBackupRequest AWS API Documentation
|
2111
|
+
#
|
2112
|
+
class CreateVolumeFromBackupRequest < Struct.new(
|
2113
|
+
:backup_id,
|
2114
|
+
:client_request_token,
|
2115
|
+
:name,
|
2116
|
+
:ontap_configuration,
|
2117
|
+
:tags)
|
2118
|
+
SENSITIVE = []
|
2119
|
+
include Aws::Structure
|
2120
|
+
end
|
2121
|
+
|
2122
|
+
# @!attribute [rw] volume
|
2123
|
+
# Returned after a successful `CreateVolumeFromBackup` API operation,
|
2124
|
+
# describing the volume just created.
|
2125
|
+
# @return [Types::Volume]
|
2126
|
+
#
|
2127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeFromBackupResponse AWS API Documentation
|
2128
|
+
#
|
2129
|
+
class CreateVolumeFromBackupResponse < Struct.new(
|
2130
|
+
:volume)
|
2131
|
+
SENSITIVE = []
|
2132
|
+
include Aws::Structure
|
2133
|
+
end
|
2134
|
+
|
2135
|
+
# @note When making an API call, you may pass CreateVolumeRequest
|
2136
|
+
# data as a hash:
|
2137
|
+
#
|
2138
|
+
# {
|
2139
|
+
# client_request_token: "ClientRequestToken",
|
2140
|
+
# volume_type: "ONTAP", # required, accepts ONTAP
|
2141
|
+
# name: "VolumeName", # required
|
2142
|
+
# ontap_configuration: {
|
2143
|
+
# junction_path: "JunctionPath", # required
|
2144
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
2145
|
+
# size_in_megabytes: 1, # required
|
2146
|
+
# storage_efficiency_enabled: false, # required
|
2147
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
2148
|
+
# tiering_policy: {
|
2149
|
+
# cooling_period: 1,
|
2150
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
2151
|
+
# },
|
2152
|
+
# },
|
2153
|
+
# tags: [
|
2154
|
+
# {
|
2155
|
+
# key: "TagKey", # required
|
2156
|
+
# value: "TagValue", # required
|
2157
|
+
# },
|
2158
|
+
# ],
|
2159
|
+
# }
|
2160
|
+
#
|
2161
|
+
# @!attribute [rw] client_request_token
|
2162
|
+
# (Optional) An idempotency token for resource creation, in a string
|
2163
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
2164
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
2165
|
+
# Amazon Web Services SDK.
|
2166
|
+
#
|
2167
|
+
# **A suitable default value is auto-generated.** You should normally
|
2168
|
+
# not need to pass this option.
|
2169
|
+
# @return [String]
|
2170
|
+
#
|
2171
|
+
# @!attribute [rw] volume_type
|
2172
|
+
# Specifies the type of volume to create; `ONTAP` is the only valid
|
2173
|
+
# volume type.
|
2174
|
+
# @return [String]
|
2175
|
+
#
|
2176
|
+
# @!attribute [rw] name
|
2177
|
+
# Specifies the name of the volume you're creating.
|
2178
|
+
# @return [String]
|
2179
|
+
#
|
2180
|
+
# @!attribute [rw] ontap_configuration
|
2181
|
+
# Specifies the `ONTAP` configuration to use in creating the volume.
|
2182
|
+
# @return [Types::CreateOntapVolumeConfiguration]
|
2183
|
+
#
|
2184
|
+
# @!attribute [rw] tags
|
2185
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
2186
|
+
# @return [Array<Types::Tag>]
|
2187
|
+
#
|
2188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeRequest AWS API Documentation
|
2189
|
+
#
|
2190
|
+
class CreateVolumeRequest < Struct.new(
|
2191
|
+
:client_request_token,
|
2192
|
+
:volume_type,
|
2193
|
+
:name,
|
2194
|
+
:ontap_configuration,
|
2195
|
+
:tags)
|
2196
|
+
SENSITIVE = []
|
2197
|
+
include Aws::Structure
|
2198
|
+
end
|
2199
|
+
|
2200
|
+
# @!attribute [rw] volume
|
2201
|
+
# Returned after a successful `CreateVolume` API operation, describing
|
2202
|
+
# the volume just created.
|
2203
|
+
# @return [Types::Volume]
|
2204
|
+
#
|
2205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeResponse AWS API Documentation
|
2206
|
+
#
|
2207
|
+
class CreateVolumeResponse < Struct.new(
|
2208
|
+
:volume)
|
2209
|
+
SENSITIVE = []
|
2210
|
+
include Aws::Structure
|
2211
|
+
end
|
2212
|
+
|
2213
|
+
# The data repository configuration object for Lustre file systems
|
2214
|
+
# returned in the response of the `CreateFileSystem` operation.
|
2215
|
+
#
|
2216
|
+
# @!attribute [rw] lifecycle
|
2217
|
+
# Describes the state of the file system's S3 durable data
|
2218
|
+
# repository, if it is configured with an S3 repository. The lifecycle
|
2219
|
+
# can have the following values:
|
2220
|
+
#
|
2221
|
+
# * `CREATING` - The data repository configuration between the FSx
|
2222
|
+
# file system and the linked S3 data repository is being created.
|
2223
|
+
# The data repository is unavailable.
|
2224
|
+
#
|
2225
|
+
# * `AVAILABLE` - The data repository is available for use.
|
2226
|
+
#
|
2227
|
+
# * `MISCONFIGURED` - Amazon FSx cannot automatically import updates
|
2228
|
+
# from the S3 bucket until the data repository configuration is
|
2229
|
+
# corrected. For more information, see [Troubleshooting a
|
2230
|
+
# Misconfigured linked S3 bucket][1].
|
2231
|
+
#
|
2232
|
+
# * `UPDATING` - The data repository is undergoing a customer
|
2233
|
+
# initiated update and availability may be impacted.
|
2234
|
+
#
|
2235
|
+
#
|
2236
|
+
#
|
2237
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository
|
2238
|
+
# @return [String]
|
2239
|
+
#
|
2240
|
+
# @!attribute [rw] import_path
|
2241
|
+
# The import path to the Amazon S3 bucket (and optional prefix) that
|
2242
|
+
# you're using as the data repository for your FSx for Lustre file
|
2243
|
+
# system, for example `s3://import-bucket/optional-prefix`. If a
|
2244
|
+
# prefix is specified after the Amazon S3 bucket name, only object
|
2245
|
+
# keys with that prefix are loaded into the file system.
|
2246
|
+
# @return [String]
|
2247
|
+
#
|
2248
|
+
# @!attribute [rw] export_path
|
2249
|
+
# The export path to the Amazon S3 bucket (and prefix) that you are
|
2250
|
+
# using to store new and changed Lustre file system files in S3.
|
2251
|
+
# @return [String]
|
2252
|
+
#
|
2253
|
+
# @!attribute [rw] imported_file_chunk_size
|
2254
|
+
# For files imported from a data repository, this value determines the
|
2255
|
+
# stripe count and maximum amount of data per file (in MiB) stored on
|
2256
|
+
# a single physical disk. The maximum number of disks that a single
|
2257
|
+
# file can be striped across is limited by the total number of disks
|
2258
|
+
# that make up the file system.
|
2259
|
+
#
|
2260
|
+
# The default chunk size is 1,024 MiB (1 GiB) and can go as high as
|
2261
|
+
# 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5
|
2262
|
+
# TB.
|
2263
|
+
# @return [Integer]
|
2264
|
+
#
|
2265
|
+
# @!attribute [rw] auto_import_policy
|
2266
|
+
# Describes the file system's linked S3 data repository's
|
2267
|
+
# `AutoImportPolicy`. The AutoImportPolicy configures how Amazon FSx
|
2268
|
+
# keeps your file and directory listings up to date as you add or
|
2269
|
+
# modify objects in your linked S3 bucket. `AutoImportPolicy` can have
|
2270
|
+
# the following values:
|
2271
|
+
#
|
2272
|
+
# * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file
|
2273
|
+
# and directory listings from the linked S3 bucket when the file
|
2274
|
+
# system is created. FSx does not update file and directory listings
|
2275
|
+
# for any new or changed objects after choosing this option.
|
2276
|
+
#
|
2277
|
+
# * `NEW` - AutoImport is on. Amazon FSx automatically imports
|
2278
|
+
# directory listings of any new objects added to the linked S3
|
2279
|
+
# bucket that do not currently exist in the FSx file system.
|
2280
|
+
#
|
2281
|
+
# * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports
|
2282
|
+
# file and directory listings of any new objects added to the S3
|
2283
|
+
# bucket and any existing objects that are changed in the S3 bucket
|
2284
|
+
# after you choose this option.
|
2285
|
+
#
|
2286
|
+
# For more information, see [Automatically import updates from your S3
|
2287
|
+
# bucket][1].
|
2288
|
+
#
|
2289
|
+
#
|
2290
|
+
#
|
2291
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html
|
2292
|
+
# @return [String]
|
2293
|
+
#
|
2294
|
+
# @!attribute [rw] failure_details
|
2295
|
+
# Provides detailed information about the data respository if its
|
2296
|
+
# `Lifecycle` is set to `MISCONFIGURED`.
|
2297
|
+
# @return [Types::DataRepositoryFailureDetails]
|
2298
|
+
#
|
2299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryConfiguration AWS API Documentation
|
2300
|
+
#
|
2301
|
+
class DataRepositoryConfiguration < Struct.new(
|
2302
|
+
:lifecycle,
|
2303
|
+
:import_path,
|
2304
|
+
:export_path,
|
2305
|
+
:imported_file_chunk_size,
|
2306
|
+
:auto_import_policy,
|
2307
|
+
:failure_details)
|
2308
|
+
SENSITIVE = []
|
2309
|
+
include Aws::Structure
|
2310
|
+
end
|
2311
|
+
|
2312
|
+
# Provides detailed information about the data respository if its
|
2313
|
+
# `Lifecycle` is set to `MISCONFIGURED`.
|
2314
|
+
#
|
2315
|
+
# @!attribute [rw] message
|
2316
|
+
# A detailed error message.
|
2317
|
+
# @return [String]
|
2318
|
+
#
|
2319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryFailureDetails AWS API Documentation
|
2320
|
+
#
|
2321
|
+
class DataRepositoryFailureDetails < Struct.new(
|
2322
|
+
:message)
|
2323
|
+
SENSITIVE = []
|
2324
|
+
include Aws::Structure
|
2325
|
+
end
|
2326
|
+
|
2327
|
+
# A description of the data repository task. You use data repository
|
2328
|
+
# tasks to perform bulk transfer operations between your Amazon FSx file
|
2329
|
+
# system and its linked data repository.
|
2330
|
+
#
|
2331
|
+
# @!attribute [rw] task_id
|
2332
|
+
# The system-generated, unique 17-digit ID of the data repository
|
2333
|
+
# task.
|
2334
|
+
# @return [String]
|
2335
|
+
#
|
2336
|
+
# @!attribute [rw] lifecycle
|
2337
|
+
# The lifecycle status of the data repository task, as follows:
|
2338
|
+
#
|
2339
|
+
# * `PENDING` - Amazon FSx has not started the task.
|
2340
|
+
#
|
2341
|
+
# * `EXECUTING` - Amazon FSx is processing the task.
|
2342
|
+
#
|
2343
|
+
# * `FAILED` - Amazon FSx was not able to complete the task. For
|
1793
2344
|
# example, there may be files the task failed to process. The
|
1794
2345
|
# DataRepositoryTaskFailureDetails property provides more
|
1795
2346
|
# information about task failures.
|
@@ -1832,10 +2383,10 @@ module Aws::FSx
|
|
1832
2383
|
#
|
1833
2384
|
# @!attribute [rw] resource_arn
|
1834
2385
|
# The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
|
1835
|
-
# identify
|
1836
|
-
# resource unambiguously across all of
|
1837
|
-
#
|
1838
|
-
# *
|
2386
|
+
# identify Amazon Web Services resources. We require an ARN when you
|
2387
|
+
# need to specify a resource unambiguously across all of Amazon Web
|
2388
|
+
# Services. For more information, see [Amazon Resource Names
|
2389
|
+
# (ARNs)][1] in the *Amazon Web Services General Reference*.
|
1839
2390
|
#
|
1840
2391
|
#
|
1841
2392
|
#
|
@@ -2052,7 +2603,7 @@ module Aws::FSx
|
|
2052
2603
|
# @!attribute [rw] client_request_token
|
2053
2604
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
2054
2605
|
# idempotent deletion. This is automatically filled on your behalf
|
2055
|
-
# when using the
|
2606
|
+
# when using the CLI or SDK.
|
2056
2607
|
#
|
2057
2608
|
# **A suitable default value is auto-generated.** You should normally
|
2058
2609
|
# not need to pass this option.
|
@@ -2181,7 +2732,8 @@ module Aws::FSx
|
|
2181
2732
|
# @!attribute [rw] client_request_token
|
2182
2733
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
2183
2734
|
# idempotent deletion. This is automatically filled on your behalf
|
2184
|
-
# when using the
|
2735
|
+
# when using the Command Line Interface (CLI) or an Amazon Web
|
2736
|
+
# Services SDK.
|
2185
2737
|
#
|
2186
2738
|
# **A suitable default value is auto-generated.** You should normally
|
2187
2739
|
# not need to pass this option.
|
@@ -2297,32 +2849,203 @@ module Aws::FSx
|
|
2297
2849
|
include Aws::Structure
|
2298
2850
|
end
|
2299
2851
|
|
2300
|
-
#
|
2301
|
-
#
|
2302
|
-
# @note When making an API call, you may pass DescribeBackupsRequest
|
2852
|
+
# @note When making an API call, you may pass DeleteStorageVirtualMachineRequest
|
2303
2853
|
# data as a hash:
|
2304
2854
|
#
|
2305
2855
|
# {
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
# {
|
2309
|
-
# name: "file-system-id", # accepts file-system-id, backup-type, file-system-type
|
2310
|
-
# values: ["FilterValue"],
|
2311
|
-
# },
|
2312
|
-
# ],
|
2313
|
-
# max_results: 1,
|
2314
|
-
# next_token: "NextToken",
|
2856
|
+
# client_request_token: "ClientRequestToken",
|
2857
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
2315
2858
|
# }
|
2316
2859
|
#
|
2317
|
-
# @!attribute [rw]
|
2318
|
-
#
|
2319
|
-
#
|
2320
|
-
#
|
2860
|
+
# @!attribute [rw] client_request_token
|
2861
|
+
# (Optional) An idempotency token for resource creation, in a string
|
2862
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
2863
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
2864
|
+
# Amazon Web Services SDK.
|
2321
2865
|
#
|
2322
|
-
#
|
2323
|
-
#
|
2324
|
-
#
|
2325
|
-
#
|
2866
|
+
# **A suitable default value is auto-generated.** You should normally
|
2867
|
+
# not need to pass this option.
|
2868
|
+
# @return [String]
|
2869
|
+
#
|
2870
|
+
# @!attribute [rw] storage_virtual_machine_id
|
2871
|
+
# The ID of the SVM that you want to delete.
|
2872
|
+
# @return [String]
|
2873
|
+
#
|
2874
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteStorageVirtualMachineRequest AWS API Documentation
|
2875
|
+
#
|
2876
|
+
class DeleteStorageVirtualMachineRequest < Struct.new(
|
2877
|
+
:client_request_token,
|
2878
|
+
:storage_virtual_machine_id)
|
2879
|
+
SENSITIVE = []
|
2880
|
+
include Aws::Structure
|
2881
|
+
end
|
2882
|
+
|
2883
|
+
# @!attribute [rw] storage_virtual_machine_id
|
2884
|
+
# The ID of the SVM Amazon FSx is deleting.
|
2885
|
+
# @return [String]
|
2886
|
+
#
|
2887
|
+
# @!attribute [rw] lifecycle
|
2888
|
+
# Describes the lifecycle state of the SVM being deleted.
|
2889
|
+
# @return [String]
|
2890
|
+
#
|
2891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteStorageVirtualMachineResponse AWS API Documentation
|
2892
|
+
#
|
2893
|
+
class DeleteStorageVirtualMachineResponse < Struct.new(
|
2894
|
+
:storage_virtual_machine_id,
|
2895
|
+
:lifecycle)
|
2896
|
+
SENSITIVE = []
|
2897
|
+
include Aws::Structure
|
2898
|
+
end
|
2899
|
+
|
2900
|
+
# Use to specify skipping a final backup, or to add tags to a final
|
2901
|
+
# backup.
|
2902
|
+
#
|
2903
|
+
# @note When making an API call, you may pass DeleteVolumeOntapConfiguration
|
2904
|
+
# data as a hash:
|
2905
|
+
#
|
2906
|
+
# {
|
2907
|
+
# skip_final_backup: false,
|
2908
|
+
# final_backup_tags: [
|
2909
|
+
# {
|
2910
|
+
# key: "TagKey", # required
|
2911
|
+
# value: "TagValue", # required
|
2912
|
+
# },
|
2913
|
+
# ],
|
2914
|
+
# }
|
2915
|
+
#
|
2916
|
+
# @!attribute [rw] skip_final_backup
|
2917
|
+
# Set to true if you want to skip taking a final backup of the volume
|
2918
|
+
# you are deleting.
|
2919
|
+
# @return [Boolean]
|
2920
|
+
#
|
2921
|
+
# @!attribute [rw] final_backup_tags
|
2922
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
2923
|
+
# @return [Array<Types::Tag>]
|
2924
|
+
#
|
2925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOntapConfiguration AWS API Documentation
|
2926
|
+
#
|
2927
|
+
class DeleteVolumeOntapConfiguration < Struct.new(
|
2928
|
+
:skip_final_backup,
|
2929
|
+
:final_backup_tags)
|
2930
|
+
SENSITIVE = []
|
2931
|
+
include Aws::Structure
|
2932
|
+
end
|
2933
|
+
|
2934
|
+
# The response object for the Amazon FSx for NetApp ONTAP volume being
|
2935
|
+
# deleted in the `DeleteVolume` operation.
|
2936
|
+
#
|
2937
|
+
# @!attribute [rw] final_backup_id
|
2938
|
+
# The ID of the source backup. Specifies the backup you are copying.
|
2939
|
+
# @return [String]
|
2940
|
+
#
|
2941
|
+
# @!attribute [rw] final_backup_tags
|
2942
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
2943
|
+
# @return [Array<Types::Tag>]
|
2944
|
+
#
|
2945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOntapResponse AWS API Documentation
|
2946
|
+
#
|
2947
|
+
class DeleteVolumeOntapResponse < Struct.new(
|
2948
|
+
:final_backup_id,
|
2949
|
+
:final_backup_tags)
|
2950
|
+
SENSITIVE = []
|
2951
|
+
include Aws::Structure
|
2952
|
+
end
|
2953
|
+
|
2954
|
+
# @note When making an API call, you may pass DeleteVolumeRequest
|
2955
|
+
# data as a hash:
|
2956
|
+
#
|
2957
|
+
# {
|
2958
|
+
# client_request_token: "ClientRequestToken",
|
2959
|
+
# volume_id: "VolumeId", # required
|
2960
|
+
# ontap_configuration: {
|
2961
|
+
# skip_final_backup: false,
|
2962
|
+
# final_backup_tags: [
|
2963
|
+
# {
|
2964
|
+
# key: "TagKey", # required
|
2965
|
+
# value: "TagValue", # required
|
2966
|
+
# },
|
2967
|
+
# ],
|
2968
|
+
# },
|
2969
|
+
# }
|
2970
|
+
#
|
2971
|
+
# @!attribute [rw] client_request_token
|
2972
|
+
# (Optional) An idempotency token for resource creation, in a string
|
2973
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
2974
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
2975
|
+
# Amazon Web Services SDK.
|
2976
|
+
#
|
2977
|
+
# **A suitable default value is auto-generated.** You should normally
|
2978
|
+
# not need to pass this option.
|
2979
|
+
# @return [String]
|
2980
|
+
#
|
2981
|
+
# @!attribute [rw] volume_id
|
2982
|
+
# The ID of the volume you are deleting.
|
2983
|
+
# @return [String]
|
2984
|
+
#
|
2985
|
+
# @!attribute [rw] ontap_configuration
|
2986
|
+
# For Amazon FSx for ONTAP volumes, specify whether to take a final
|
2987
|
+
# backup of the volume, and apply tags to the backup.
|
2988
|
+
# @return [Types::DeleteVolumeOntapConfiguration]
|
2989
|
+
#
|
2990
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeRequest AWS API Documentation
|
2991
|
+
#
|
2992
|
+
class DeleteVolumeRequest < Struct.new(
|
2993
|
+
:client_request_token,
|
2994
|
+
:volume_id,
|
2995
|
+
:ontap_configuration)
|
2996
|
+
SENSITIVE = []
|
2997
|
+
include Aws::Structure
|
2998
|
+
end
|
2999
|
+
|
3000
|
+
# @!attribute [rw] volume_id
|
3001
|
+
# The ID of the volume being deleted.
|
3002
|
+
# @return [String]
|
3003
|
+
#
|
3004
|
+
# @!attribute [rw] lifecycle
|
3005
|
+
# Describes the lifecycle state of the volume being deleted.
|
3006
|
+
# @return [String]
|
3007
|
+
#
|
3008
|
+
# @!attribute [rw] ontap_response
|
3009
|
+
# Returned after a `DeleteVolume request, showing the status of the
|
3010
|
+
# delete request.`
|
3011
|
+
# @return [Types::DeleteVolumeOntapResponse]
|
3012
|
+
#
|
3013
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeResponse AWS API Documentation
|
3014
|
+
#
|
3015
|
+
class DeleteVolumeResponse < Struct.new(
|
3016
|
+
:volume_id,
|
3017
|
+
:lifecycle,
|
3018
|
+
:ontap_response)
|
3019
|
+
SENSITIVE = []
|
3020
|
+
include Aws::Structure
|
3021
|
+
end
|
3022
|
+
|
3023
|
+
# The request object for `DescribeBackups` operation.
|
3024
|
+
#
|
3025
|
+
# @note When making an API call, you may pass DescribeBackupsRequest
|
3026
|
+
# data as a hash:
|
3027
|
+
#
|
3028
|
+
# {
|
3029
|
+
# backup_ids: ["BackupId"],
|
3030
|
+
# filters: [
|
3031
|
+
# {
|
3032
|
+
# name: "file-system-id", # accepts file-system-id, backup-type, file-system-type, volume-id
|
3033
|
+
# values: ["FilterValue"],
|
3034
|
+
# },
|
3035
|
+
# ],
|
3036
|
+
# max_results: 1,
|
3037
|
+
# next_token: "NextToken",
|
3038
|
+
# }
|
3039
|
+
#
|
3040
|
+
# @!attribute [rw] backup_ids
|
3041
|
+
# IDs of the backups you want to retrieve (String). This overrides any
|
3042
|
+
# filters. If any IDs are not found, BackupNotFound will be thrown.
|
3043
|
+
# @return [Array<String>]
|
3044
|
+
#
|
3045
|
+
# @!attribute [rw] filters
|
3046
|
+
# Filters structure. Supported names are `file-system-id`,
|
3047
|
+
# `backup-type`, `file-system-type`, and `volume-id`.
|
3048
|
+
# @return [Array<Types::Filter>]
|
2326
3049
|
#
|
2327
3050
|
# @!attribute [rw] max_results
|
2328
3051
|
# Maximum number of backups to return in the response (integer). This
|
@@ -2454,8 +3177,8 @@ module Aws::FSx
|
|
2454
3177
|
# @!attribute [rw] client_request_token
|
2455
3178
|
# (Optional) An idempotency token for resource creation, in a string
|
2456
3179
|
# of up to 64 ASCII characters. This token is automatically filled on
|
2457
|
-
# your behalf when you use the
|
2458
|
-
#
|
3180
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
3181
|
+
# Amazon Web Services SDK.
|
2459
3182
|
#
|
2460
3183
|
# **A suitable default value is auto-generated.** You should normally
|
2461
3184
|
# not need to pass this option.
|
@@ -2575,6 +3298,140 @@ module Aws::FSx
|
|
2575
3298
|
include Aws::Structure
|
2576
3299
|
end
|
2577
3300
|
|
3301
|
+
# @note When making an API call, you may pass DescribeStorageVirtualMachinesRequest
|
3302
|
+
# data as a hash:
|
3303
|
+
#
|
3304
|
+
# {
|
3305
|
+
# storage_virtual_machine_ids: ["StorageVirtualMachineId"],
|
3306
|
+
# filters: [
|
3307
|
+
# {
|
3308
|
+
# name: "file-system-id", # accepts file-system-id
|
3309
|
+
# values: ["StorageVirtualMachineFilterValue"],
|
3310
|
+
# },
|
3311
|
+
# ],
|
3312
|
+
# max_results: 1,
|
3313
|
+
# next_token: "NextToken",
|
3314
|
+
# }
|
3315
|
+
#
|
3316
|
+
# @!attribute [rw] storage_virtual_machine_ids
|
3317
|
+
# Enter the ID of one or more SVMs that you want to view.
|
3318
|
+
# @return [Array<String>]
|
3319
|
+
#
|
3320
|
+
# @!attribute [rw] filters
|
3321
|
+
# Enter a filter name:value pair to view a select set of SVMs.
|
3322
|
+
# @return [Array<Types::StorageVirtualMachineFilter>]
|
3323
|
+
#
|
3324
|
+
# @!attribute [rw] max_results
|
3325
|
+
# The maximum number of resources to return in the response. This
|
3326
|
+
# value must be an integer greater than zero.
|
3327
|
+
# @return [Integer]
|
3328
|
+
#
|
3329
|
+
# @!attribute [rw] next_token
|
3330
|
+
# (Optional) Opaque pagination token returned from a previous
|
3331
|
+
# operation (String). If present, this token indicates from what point
|
3332
|
+
# you can continue processing the request, where the previous
|
3333
|
+
# `NextToken` value left off.
|
3334
|
+
# @return [String]
|
3335
|
+
#
|
3336
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeStorageVirtualMachinesRequest AWS API Documentation
|
3337
|
+
#
|
3338
|
+
class DescribeStorageVirtualMachinesRequest < Struct.new(
|
3339
|
+
:storage_virtual_machine_ids,
|
3340
|
+
:filters,
|
3341
|
+
:max_results,
|
3342
|
+
:next_token)
|
3343
|
+
SENSITIVE = []
|
3344
|
+
include Aws::Structure
|
3345
|
+
end
|
3346
|
+
|
3347
|
+
# @!attribute [rw] storage_virtual_machines
|
3348
|
+
# Returned after a successful `DescribeStorageVirtualMachines`
|
3349
|
+
# operation, describing each SVM.
|
3350
|
+
# @return [Array<Types::StorageVirtualMachine>]
|
3351
|
+
#
|
3352
|
+
# @!attribute [rw] next_token
|
3353
|
+
# (Optional) Opaque pagination token returned from a previous
|
3354
|
+
# operation (String). If present, this token indicates from what point
|
3355
|
+
# you can continue processing the request, where the previous
|
3356
|
+
# `NextToken` value left off.
|
3357
|
+
# @return [String]
|
3358
|
+
#
|
3359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeStorageVirtualMachinesResponse AWS API Documentation
|
3360
|
+
#
|
3361
|
+
class DescribeStorageVirtualMachinesResponse < Struct.new(
|
3362
|
+
:storage_virtual_machines,
|
3363
|
+
:next_token)
|
3364
|
+
SENSITIVE = []
|
3365
|
+
include Aws::Structure
|
3366
|
+
end
|
3367
|
+
|
3368
|
+
# @note When making an API call, you may pass DescribeVolumesRequest
|
3369
|
+
# data as a hash:
|
3370
|
+
#
|
3371
|
+
# {
|
3372
|
+
# volume_ids: ["VolumeId"],
|
3373
|
+
# filters: [
|
3374
|
+
# {
|
3375
|
+
# name: "file-system-id", # accepts file-system-id, storage-virtual-machine-id
|
3376
|
+
# values: ["VolumeFilterValue"],
|
3377
|
+
# },
|
3378
|
+
# ],
|
3379
|
+
# max_results: 1,
|
3380
|
+
# next_token: "NextToken",
|
3381
|
+
# }
|
3382
|
+
#
|
3383
|
+
# @!attribute [rw] volume_ids
|
3384
|
+
# IDs of the volumes whose descriptions you want to retrieve.
|
3385
|
+
# @return [Array<String>]
|
3386
|
+
#
|
3387
|
+
# @!attribute [rw] filters
|
3388
|
+
# Enter a filter name:value pair to view a select set of volumes.
|
3389
|
+
# @return [Array<Types::VolumeFilter>]
|
3390
|
+
#
|
3391
|
+
# @!attribute [rw] max_results
|
3392
|
+
# The maximum number of resources to return in the response. This
|
3393
|
+
# value must be an integer greater than zero.
|
3394
|
+
# @return [Integer]
|
3395
|
+
#
|
3396
|
+
# @!attribute [rw] next_token
|
3397
|
+
# (Optional) Opaque pagination token returned from a previous
|
3398
|
+
# operation (String). If present, this token indicates from what point
|
3399
|
+
# you can continue processing the request, where the previous
|
3400
|
+
# `NextToken` value left off.
|
3401
|
+
# @return [String]
|
3402
|
+
#
|
3403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumesRequest AWS API Documentation
|
3404
|
+
#
|
3405
|
+
class DescribeVolumesRequest < Struct.new(
|
3406
|
+
:volume_ids,
|
3407
|
+
:filters,
|
3408
|
+
:max_results,
|
3409
|
+
:next_token)
|
3410
|
+
SENSITIVE = []
|
3411
|
+
include Aws::Structure
|
3412
|
+
end
|
3413
|
+
|
3414
|
+
# @!attribute [rw] volumes
|
3415
|
+
# Returned after a successful `DescribeVolumes` operation, describing
|
3416
|
+
# each volume.
|
3417
|
+
# @return [Array<Types::Volume>]
|
3418
|
+
#
|
3419
|
+
# @!attribute [rw] next_token
|
3420
|
+
# (Optional) Opaque pagination token returned from a previous
|
3421
|
+
# operation (String). If present, this token indicates from what point
|
3422
|
+
# you can continue processing the request, where the previous
|
3423
|
+
# `NextToken` value left off.
|
3424
|
+
# @return [String]
|
3425
|
+
#
|
3426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumesResponse AWS API Documentation
|
3427
|
+
#
|
3428
|
+
class DescribeVolumesResponse < Struct.new(
|
3429
|
+
:volumes,
|
3430
|
+
:next_token)
|
3431
|
+
SENSITIVE = []
|
3432
|
+
include Aws::Structure
|
3433
|
+
end
|
3434
|
+
|
2578
3435
|
# The request object of DNS aliases to disassociate from an Amazon FSx
|
2579
3436
|
# for Windows File Server file system.
|
2580
3437
|
#
|
@@ -2590,8 +3447,8 @@ module Aws::FSx
|
|
2590
3447
|
# @!attribute [rw] client_request_token
|
2591
3448
|
# (Optional) An idempotency token for resource creation, in a string
|
2592
3449
|
# of up to 64 ASCII characters. This token is automatically filled on
|
2593
|
-
# your behalf when you use the
|
2594
|
-
#
|
3450
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
3451
|
+
# Amazon Web Services SDK.
|
2595
3452
|
#
|
2596
3453
|
# **A suitable default value is auto-generated.** You should normally
|
2597
3454
|
# not need to pass this option.
|
@@ -2635,12 +3492,47 @@ module Aws::FSx
|
|
2635
3492
|
include Aws::Structure
|
2636
3493
|
end
|
2637
3494
|
|
3495
|
+
# The SSD IOPS (input/output operations per second) configuration for an
|
3496
|
+
# Amazon FSx for NetApp ONTAP file system. The default is 3 IOPS per GB
|
3497
|
+
# of storage capacity, but you can provision additional IOPS per GB of
|
3498
|
+
# storage. The configuration consists of the total number of provisioned
|
3499
|
+
# SSD IOPS and how the amount was provisioned (by the customer or by the
|
3500
|
+
# system).
|
3501
|
+
#
|
3502
|
+
# @note When making an API call, you may pass DiskIopsConfiguration
|
3503
|
+
# data as a hash:
|
3504
|
+
#
|
3505
|
+
# {
|
3506
|
+
# mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
|
3507
|
+
# iops: 1,
|
3508
|
+
# }
|
3509
|
+
#
|
3510
|
+
# @!attribute [rw] mode
|
3511
|
+
# Specifies whether the number of IOPS for the file system is using
|
3512
|
+
# the system default (`AUTOMATIC`) or was provisioned by the customer
|
3513
|
+
# (`USER_PROVISIONED`).
|
3514
|
+
# @return [String]
|
3515
|
+
#
|
3516
|
+
# @!attribute [rw] iops
|
3517
|
+
# The total number of SSD IOPS provisioned for the file system.
|
3518
|
+
# @return [Integer]
|
3519
|
+
#
|
3520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DiskIopsConfiguration AWS API Documentation
|
3521
|
+
#
|
3522
|
+
class DiskIopsConfiguration < Struct.new(
|
3523
|
+
:mode,
|
3524
|
+
:iops)
|
3525
|
+
SENSITIVE = []
|
3526
|
+
include Aws::Structure
|
3527
|
+
end
|
3528
|
+
|
2638
3529
|
# A description of a specific Amazon FSx file system.
|
2639
3530
|
#
|
2640
3531
|
# @!attribute [rw] owner_id
|
2641
|
-
# The
|
2642
|
-
# created by an
|
2643
|
-
# account to which the IAM user belongs
|
3532
|
+
# The Amazon Web Services account that created the file system. If the
|
3533
|
+
# file system was created by an Identity and Access Management (IAM)
|
3534
|
+
# user, the Amazon Web Services account to which the IAM user belongs
|
3535
|
+
# is the owner.
|
2644
3536
|
# @return [String]
|
2645
3537
|
#
|
2646
3538
|
# @!attribute [rw] creation_time
|
@@ -2653,7 +3545,8 @@ module Aws::FSx
|
|
2653
3545
|
# @return [String]
|
2654
3546
|
#
|
2655
3547
|
# @!attribute [rw] file_system_type
|
2656
|
-
# The type of Amazon FSx file system,
|
3548
|
+
# The type of Amazon FSx file system, which can be `LUSTRE`,
|
3549
|
+
# `WINDOWS`, or `ONTAP`.
|
2657
3550
|
# @return [String]
|
2658
3551
|
#
|
2659
3552
|
# @!attribute [rw] lifecycle
|
@@ -2700,16 +3593,16 @@ module Aws::FSx
|
|
2700
3593
|
#
|
2701
3594
|
# @!attribute [rw] subnet_ids
|
2702
3595
|
# Specifies the IDs of the subnets that the file system is accessible
|
2703
|
-
# from. For Windows `MULTI_AZ_1` file system deployment
|
2704
|
-
# are two subnet IDs, one for the preferred file server
|
2705
|
-
# the standby file server. The preferred file server
|
2706
|
-
# in the `PreferredSubnetID` property. All other
|
2707
|
-
# only one subnet ID.
|
3596
|
+
# from. For Windows and ONTAP `MULTI_AZ_1` file system deployment
|
3597
|
+
# type, there are two subnet IDs, one for the preferred file server
|
3598
|
+
# and one for the standby file server. The preferred file server
|
3599
|
+
# subnet identified in the `PreferredSubnetID` property. All other
|
3600
|
+
# file systems have only one subnet ID.
|
2708
3601
|
#
|
2709
3602
|
# For Lustre file systems, and Single-AZ Windows file systems, this is
|
2710
3603
|
# the ID of the subnet that contains the endpoint for the file system.
|
2711
|
-
# For `MULTI_AZ_1` Windows file systems, the endpoint for
|
2712
|
-
# system is available in the `PreferredSubnetID`.
|
3604
|
+
# For `MULTI_AZ_1` Windows and ONTAP file systems, the endpoint for
|
3605
|
+
# the file system is available in the `PreferredSubnetID`.
|
2713
3606
|
# @return [Array<String>]
|
2714
3607
|
#
|
2715
3608
|
# @!attribute [rw] network_interface_ids
|
@@ -2733,14 +3626,14 @@ module Aws::FSx
|
|
2733
3626
|
# @return [String]
|
2734
3627
|
#
|
2735
3628
|
# @!attribute [rw] kms_key_id
|
2736
|
-
# The ID of the
|
2737
|
-
#
|
2738
|
-
#
|
2739
|
-
# systems at rest.
|
2740
|
-
# managed key is used. The scratch Amazon FSx for Lustre
|
2741
|
-
# are always encrypted at rest using Amazon FSx managed
|
2742
|
-
# information, see [Encrypt][1] in the *
|
2743
|
-
# Reference*.
|
3629
|
+
# The ID of the Key Management Service (KMS) key used to encrypt the
|
3630
|
+
# file system's data for Amazon FSx for Windows File Server file
|
3631
|
+
# systems, Amazon FSx for NetApp ONTAP file systems, and persistent
|
3632
|
+
# Amazon FSx for Lustre file systems at rest. If not specified, the
|
3633
|
+
# Amazon FSx managed key is used. The scratch Amazon FSx for Lustre
|
3634
|
+
# file systems are always encrypted at rest using Amazon FSx managed
|
3635
|
+
# keys. For more information, see [Encrypt][1] in the *Key Management
|
3636
|
+
# Service API Reference*.
|
2744
3637
|
#
|
2745
3638
|
#
|
2746
3639
|
#
|
@@ -2772,10 +3665,14 @@ module Aws::FSx
|
|
2772
3665
|
# @!attribute [rw] administrative_actions
|
2773
3666
|
# A list of administrative actions for the file system that are in
|
2774
3667
|
# process or waiting to be processed. Administrative actions describe
|
2775
|
-
# changes to the
|
2776
|
-
# `UpdateFileSystem` action.
|
3668
|
+
# changes to the Amazon FSx file system that you have initiated using
|
3669
|
+
# the `UpdateFileSystem` action.
|
2777
3670
|
# @return [Array<Types::AdministrativeAction>]
|
2778
3671
|
#
|
3672
|
+
# @!attribute [rw] ontap_configuration
|
3673
|
+
# The configuration for this FSx for NetApp ONTAP file system.
|
3674
|
+
# @return [Types::OntapFileSystemConfiguration]
|
3675
|
+
#
|
2779
3676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystem AWS API Documentation
|
2780
3677
|
#
|
2781
3678
|
class FileSystem < Struct.new(
|
@@ -2796,24 +3693,71 @@ module Aws::FSx
|
|
2796
3693
|
:tags,
|
2797
3694
|
:windows_configuration,
|
2798
3695
|
:lustre_configuration,
|
2799
|
-
:administrative_actions
|
3696
|
+
:administrative_actions,
|
3697
|
+
:ontap_configuration)
|
2800
3698
|
SENSITIVE = []
|
2801
3699
|
include Aws::Structure
|
2802
3700
|
end
|
2803
3701
|
|
2804
|
-
#
|
2805
|
-
# the file system
|
3702
|
+
# An Amazon FSx for NetApp ONTAP file system has two endpoints that are
|
3703
|
+
# used to access data or to manage the file system using the NetApp
|
3704
|
+
# ONTAP CLI, REST API, or NetApp SnapMirror. They are the `Management`
|
3705
|
+
# and `Intercluster` endpoints.
|
2806
3706
|
#
|
2807
|
-
# @!attribute [rw]
|
2808
|
-
#
|
2809
|
-
#
|
3707
|
+
# @!attribute [rw] dns_name
|
3708
|
+
# The Domain Name Service (DNS) name for the file system. You can
|
3709
|
+
# mount your file system using its DNS name.
|
2810
3710
|
# @return [String]
|
2811
3711
|
#
|
2812
|
-
#
|
3712
|
+
# @!attribute [rw] ip_addresses
|
3713
|
+
# IP addresses of the file system endpoint.
|
3714
|
+
# @return [Array<String>]
|
2813
3715
|
#
|
2814
|
-
|
2815
|
-
|
2816
|
-
|
3716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemEndpoint AWS API Documentation
|
3717
|
+
#
|
3718
|
+
class FileSystemEndpoint < Struct.new(
|
3719
|
+
:dns_name,
|
3720
|
+
:ip_addresses)
|
3721
|
+
SENSITIVE = []
|
3722
|
+
include Aws::Structure
|
3723
|
+
end
|
3724
|
+
|
3725
|
+
# An Amazon FSx for NetApp ONTAP file system has the following endpoints
|
3726
|
+
# that are used to access data or to manage the file system using the
|
3727
|
+
# NetApp ONTAP CLI, REST API, or NetApp SnapMirror.
|
3728
|
+
#
|
3729
|
+
# @!attribute [rw] intercluster
|
3730
|
+
# An endpoint for managing your file system by setting up NetApp
|
3731
|
+
# SnapMirror with other ONTAP systems.
|
3732
|
+
# @return [Types::FileSystemEndpoint]
|
3733
|
+
#
|
3734
|
+
# @!attribute [rw] management
|
3735
|
+
# An endpoint for managing your file system using the NetApp ONTAP CLI
|
3736
|
+
# and NetApp ONTAP API.
|
3737
|
+
# @return [Types::FileSystemEndpoint]
|
3738
|
+
#
|
3739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemEndpoints AWS API Documentation
|
3740
|
+
#
|
3741
|
+
class FileSystemEndpoints < Struct.new(
|
3742
|
+
:intercluster,
|
3743
|
+
:management)
|
3744
|
+
SENSITIVE = []
|
3745
|
+
include Aws::Structure
|
3746
|
+
end
|
3747
|
+
|
3748
|
+
# A structure providing details of any failures that occur when creating
|
3749
|
+
# the file system has failed.
|
3750
|
+
#
|
3751
|
+
# @!attribute [rw] message
|
3752
|
+
# A message describing any failures that occurred during file system
|
3753
|
+
# creation.
|
3754
|
+
# @return [String]
|
3755
|
+
#
|
3756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemFailureDetails AWS API Documentation
|
3757
|
+
#
|
3758
|
+
class FileSystemFailureDetails < Struct.new(
|
3759
|
+
:message)
|
3760
|
+
SENSITIVE = []
|
2817
3761
|
include Aws::Structure
|
2818
3762
|
end
|
2819
3763
|
|
@@ -2839,7 +3783,7 @@ module Aws::FSx
|
|
2839
3783
|
# data as a hash:
|
2840
3784
|
#
|
2841
3785
|
# {
|
2842
|
-
# name: "file-system-id", # accepts file-system-id, backup-type, file-system-type
|
3786
|
+
# name: "file-system-id", # accepts file-system-id, backup-type, file-system-type, volume-id
|
2843
3787
|
# values: ["FilterValue"],
|
2844
3788
|
# }
|
2845
3789
|
#
|
@@ -2911,8 +3855,8 @@ module Aws::FSx
|
|
2911
3855
|
include Aws::Structure
|
2912
3856
|
end
|
2913
3857
|
|
2914
|
-
# The
|
2915
|
-
#
|
3858
|
+
# The Key Management Service (KMS) key of the destination backup is
|
3859
|
+
# invalid.
|
2916
3860
|
#
|
2917
3861
|
# @!attribute [rw] message
|
2918
3862
|
# A detailed error message.
|
@@ -2955,36 +3899,24 @@ module Aws::FSx
|
|
2955
3899
|
end
|
2956
3900
|
|
2957
3901
|
# 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
3902
|
#
|
2964
3903
|
# @!attribute [rw] message
|
2965
|
-
#
|
3904
|
+
# Error message explaining what's wrong with network settings.
|
2966
3905
|
# @return [String]
|
2967
3906
|
#
|
2968
3907
|
# @!attribute [rw] invalid_subnet_id
|
2969
|
-
# The ID
|
2970
|
-
#
|
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
|
3908
|
+
# The subnet ID that is either invalid or not part of the VPC
|
3909
|
+
# specified.
|
2976
3910
|
# @return [String]
|
2977
3911
|
#
|
2978
3912
|
# @!attribute [rw] invalid_security_group_id
|
2979
|
-
# The
|
2980
|
-
#
|
2981
|
-
#
|
2982
|
-
# Security Groups for Linux Instances][1] in the *Amazon EC2 User
|
2983
|
-
# Guide*.
|
2984
|
-
#
|
2985
|
-
#
|
3913
|
+
# The security group ID is either invalid or not part of the VPC
|
3914
|
+
# specified.
|
3915
|
+
# @return [String]
|
2986
3916
|
#
|
2987
|
-
#
|
3917
|
+
# @!attribute [rw] invalid_route_table_id
|
3918
|
+
# The route table ID is either invalid or not part of the VPC
|
3919
|
+
# specified.
|
2988
3920
|
# @return [String]
|
2989
3921
|
#
|
2990
3922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidNetworkSettings AWS API Documentation
|
@@ -2992,7 +3924,8 @@ module Aws::FSx
|
|
2992
3924
|
class InvalidNetworkSettings < Struct.new(
|
2993
3925
|
:message,
|
2994
3926
|
:invalid_subnet_id,
|
2995
|
-
:invalid_security_group_id
|
3927
|
+
:invalid_security_group_id,
|
3928
|
+
:invalid_route_table_id)
|
2996
3929
|
SENSITIVE = []
|
2997
3930
|
include Aws::Structure
|
2998
3931
|
end
|
@@ -3013,7 +3946,7 @@ module Aws::FSx
|
|
3013
3946
|
end
|
3014
3947
|
|
3015
3948
|
# The Region provided for `Source Region` is invalid or is in a
|
3016
|
-
# different
|
3949
|
+
# different Amazon Web Services partition.
|
3017
3950
|
#
|
3018
3951
|
# @!attribute [rw] message
|
3019
3952
|
# A detailed error message.
|
@@ -3027,8 +3960,7 @@ module Aws::FSx
|
|
3027
3960
|
include Aws::Structure
|
3028
3961
|
end
|
3029
3962
|
|
3030
|
-
# The
|
3031
|
-
# invalid.
|
3963
|
+
# The Key Management Service (KMS) key of the source backup is invalid.
|
3032
3964
|
#
|
3033
3965
|
# @!attribute [rw] message
|
3034
3966
|
# A detailed error message.
|
@@ -3042,6 +3974,20 @@ module Aws::FSx
|
|
3042
3974
|
include Aws::Structure
|
3043
3975
|
end
|
3044
3976
|
|
3977
|
+
# Describes why a resource lifecycle state changed.
|
3978
|
+
#
|
3979
|
+
# @!attribute [rw] message
|
3980
|
+
# A detailed error message.
|
3981
|
+
# @return [String]
|
3982
|
+
#
|
3983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LifecycleTransitionReason AWS API Documentation
|
3984
|
+
#
|
3985
|
+
class LifecycleTransitionReason < Struct.new(
|
3986
|
+
:message)
|
3987
|
+
SENSITIVE = []
|
3988
|
+
include Aws::Structure
|
3989
|
+
end
|
3990
|
+
|
3045
3991
|
# The request object for `ListTagsForResource` operation.
|
3046
3992
|
#
|
3047
3993
|
# @note When making an API call, you may pass ListTagsForResourceRequest
|
@@ -3151,7 +4097,7 @@ module Aws::FSx
|
|
3151
4097
|
#
|
3152
4098
|
# For the `SCRATCH_1` deployment type, this value is always "`fsx`".
|
3153
4099
|
# For `SCRATCH_2` and `PERSISTENT_1` deployment types, this value is a
|
3154
|
-
# string that is unique within an
|
4100
|
+
# string that is unique within an Amazon Web Services Region.
|
3155
4101
|
# @return [String]
|
3156
4102
|
#
|
3157
4103
|
# @!attribute [rw] daily_automatic_backup_start_time
|
@@ -3233,6 +4179,20 @@ module Aws::FSx
|
|
3233
4179
|
include Aws::Structure
|
3234
4180
|
end
|
3235
4181
|
|
4182
|
+
# A volume configuration is required for this operation.
|
4183
|
+
#
|
4184
|
+
# @!attribute [rw] message
|
4185
|
+
# A detailed error message.
|
4186
|
+
# @return [String]
|
4187
|
+
#
|
4188
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/MissingVolumeConfiguration AWS API Documentation
|
4189
|
+
#
|
4190
|
+
class MissingVolumeConfiguration < Struct.new(
|
4191
|
+
:message)
|
4192
|
+
SENSITIVE = []
|
4193
|
+
include Aws::Structure
|
4194
|
+
end
|
4195
|
+
|
3236
4196
|
# The resource specified for the tagging operation is not a resource
|
3237
4197
|
# type owned by Amazon FSx. Use the API of the relevant service to
|
3238
4198
|
# perform the operation.
|
@@ -3254,6 +4214,185 @@ module Aws::FSx
|
|
3254
4214
|
include Aws::Structure
|
3255
4215
|
end
|
3256
4216
|
|
4217
|
+
# Configuration for the FSx for NetApp ONTAP file system.
|
4218
|
+
#
|
4219
|
+
# @!attribute [rw] automatic_backup_retention_days
|
4220
|
+
# The number of days to retain automatic backups. Setting this to 0
|
4221
|
+
# disables automatic backups. You can retain automatic backups for a
|
4222
|
+
# maximum of 90 days. The default is 0.
|
4223
|
+
# @return [Integer]
|
4224
|
+
#
|
4225
|
+
# @!attribute [rw] daily_automatic_backup_start_time
|
4226
|
+
# A recurring daily time, in the format `HH:MM`. `HH` is the
|
4227
|
+
# zero-padded hour of the day (0-23), and `MM` is the zero-padded
|
4228
|
+
# minute of the hour. For example, `05:00` specifies 5 AM daily.
|
4229
|
+
# @return [String]
|
4230
|
+
#
|
4231
|
+
# @!attribute [rw] deployment_type
|
4232
|
+
# The ONTAP file system deployment type.
|
4233
|
+
# @return [String]
|
4234
|
+
#
|
4235
|
+
# @!attribute [rw] endpoint_ip_address_range
|
4236
|
+
# The IP address range in which the endpoints to access your file
|
4237
|
+
# system are created.
|
4238
|
+
# @return [String]
|
4239
|
+
#
|
4240
|
+
# @!attribute [rw] endpoints
|
4241
|
+
# The `Management` and `Intercluster` endpoints that are used to
|
4242
|
+
# access data or to manage the file system using the NetApp ONTAP CLI,
|
4243
|
+
# REST API, or NetApp SnapMirror.
|
4244
|
+
# @return [Types::FileSystemEndpoints]
|
4245
|
+
#
|
4246
|
+
# @!attribute [rw] disk_iops_configuration
|
4247
|
+
# The SSD IOPS configuration for the ONTAP file system, specifying the
|
4248
|
+
# number of provisioned IOPS and the provision mode.
|
4249
|
+
# @return [Types::DiskIopsConfiguration]
|
4250
|
+
#
|
4251
|
+
# @!attribute [rw] preferred_subnet_id
|
4252
|
+
# The ID for a subnet. A *subnet* is a range of IP addresses in your
|
4253
|
+
# virtual private cloud (VPC). For more information, see [VPC and
|
4254
|
+
# Subnets][1] in the *Amazon VPC User Guide.*
|
4255
|
+
#
|
4256
|
+
#
|
4257
|
+
#
|
4258
|
+
# [1]: https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html
|
4259
|
+
# @return [String]
|
4260
|
+
#
|
4261
|
+
# @!attribute [rw] route_table_ids
|
4262
|
+
# The VPC route tables in which your file system's endpoints are
|
4263
|
+
# created.
|
4264
|
+
# @return [Array<String>]
|
4265
|
+
#
|
4266
|
+
# @!attribute [rw] throughput_capacity
|
4267
|
+
# Sustained throughput of an Amazon FSx file system in MBps.
|
4268
|
+
# @return [Integer]
|
4269
|
+
#
|
4270
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
4271
|
+
# A recurring weekly time, in the format `D:HH:MM`.
|
4272
|
+
#
|
4273
|
+
# `D` is the day of the week, for which 1 represents Monday and 7
|
4274
|
+
# represents Sunday. For further details, see [the ISO-8601 spec as
|
4275
|
+
# described on Wikipedia][1].
|
4276
|
+
#
|
4277
|
+
# `HH` is the zero-padded hour of the day (0-23), and `MM` is the
|
4278
|
+
# zero-padded minute of the hour.
|
4279
|
+
#
|
4280
|
+
# For example, `1:05:00` specifies maintenance at 5 AM Monday.
|
4281
|
+
#
|
4282
|
+
#
|
4283
|
+
#
|
4284
|
+
# [1]: https://en.wikipedia.org/wiki/ISO_week_date
|
4285
|
+
# @return [String]
|
4286
|
+
#
|
4287
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapFileSystemConfiguration AWS API Documentation
|
4288
|
+
#
|
4289
|
+
class OntapFileSystemConfiguration < Struct.new(
|
4290
|
+
:automatic_backup_retention_days,
|
4291
|
+
:daily_automatic_backup_start_time,
|
4292
|
+
:deployment_type,
|
4293
|
+
:endpoint_ip_address_range,
|
4294
|
+
:endpoints,
|
4295
|
+
:disk_iops_configuration,
|
4296
|
+
:preferred_subnet_id,
|
4297
|
+
:route_table_ids,
|
4298
|
+
:throughput_capacity,
|
4299
|
+
:weekly_maintenance_start_time)
|
4300
|
+
SENSITIVE = []
|
4301
|
+
include Aws::Structure
|
4302
|
+
end
|
4303
|
+
|
4304
|
+
# The configuration of an Amazon FSx for NetApp ONTAP volume
|
4305
|
+
#
|
4306
|
+
# @!attribute [rw] flex_cache_endpoint_type
|
4307
|
+
# Specifies the FlexCache endpoint type of the volume. Valid values
|
4308
|
+
# are the following:
|
4309
|
+
#
|
4310
|
+
# * `NONE` specifies that the volume doesn't have a FlexCache
|
4311
|
+
# configuration. `NONE` is the default.
|
4312
|
+
#
|
4313
|
+
# * `ORIGIN` specifies that the volume is the origin volume for a
|
4314
|
+
# FlexCache volume.
|
4315
|
+
#
|
4316
|
+
# * `CACHE` specifies that the volume is a FlexCache volume.
|
4317
|
+
# @return [String]
|
4318
|
+
#
|
4319
|
+
# @!attribute [rw] junction_path
|
4320
|
+
# Specifies the directory that NAS clients use to mount the volume,
|
4321
|
+
# along with the SVM DNS name or IP address. You can create a
|
4322
|
+
# `JunctionPath` directly below a parent volume junction or on a
|
4323
|
+
# directory within a volume. A `JunctionPath` for a volume named vol3
|
4324
|
+
# might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even
|
4325
|
+
# /dir1/dir2/vol3..
|
4326
|
+
# @return [String]
|
4327
|
+
#
|
4328
|
+
# @!attribute [rw] security_style
|
4329
|
+
# The security style for the volume, which can be `UNIX`, `NTFS`, or
|
4330
|
+
# `MIXED`.
|
4331
|
+
# @return [String]
|
4332
|
+
#
|
4333
|
+
# @!attribute [rw] size_in_megabytes
|
4334
|
+
# The configured size of the volume, in megabytes (MBs).
|
4335
|
+
# @return [Integer]
|
4336
|
+
#
|
4337
|
+
# @!attribute [rw] storage_efficiency_enabled
|
4338
|
+
# The volume's storage efficiency setting.
|
4339
|
+
# @return [Boolean]
|
4340
|
+
#
|
4341
|
+
# @!attribute [rw] storage_virtual_machine_id
|
4342
|
+
# The ID of the volume's storage virtual machine.
|
4343
|
+
# @return [String]
|
4344
|
+
#
|
4345
|
+
# @!attribute [rw] storage_virtual_machine_root
|
4346
|
+
# A boolean flag indicating whether this volume is the root volume for
|
4347
|
+
# its storage virtual machine (SVM). Only one volume on an SVM can be
|
4348
|
+
# the root volume. This value defaults to false. If this value is
|
4349
|
+
# true, then this is the SVM root volume.
|
4350
|
+
#
|
4351
|
+
# This flag is useful when you're deleting an SVM, because you must
|
4352
|
+
# first delete all non-root volumes. This flag, when set to false,
|
4353
|
+
# helps you identify which volumes to delete before you can delete the
|
4354
|
+
# SVM.
|
4355
|
+
# @return [Boolean]
|
4356
|
+
#
|
4357
|
+
# @!attribute [rw] tiering_policy
|
4358
|
+
# The volume's `TieringPolicy` setting.
|
4359
|
+
# @return [Types::TieringPolicy]
|
4360
|
+
#
|
4361
|
+
# @!attribute [rw] uuid
|
4362
|
+
# The volume's UUID (universally unique identifier).
|
4363
|
+
# @return [String]
|
4364
|
+
#
|
4365
|
+
# @!attribute [rw] ontap_volume_type
|
4366
|
+
# Specifies the type of volume. Valid values are the following:
|
4367
|
+
#
|
4368
|
+
# * `RW` specifies a read-write volume. `RW` is the default.
|
4369
|
+
#
|
4370
|
+
# * `DP` specifies a data protection volume. You can protect data by
|
4371
|
+
# replicating it to data protection mirror copies and use data
|
4372
|
+
# protection mirror copies to recover data when a disaster occurs.
|
4373
|
+
#
|
4374
|
+
# * `LS` specifies a load-sharing mirror volume. A load-sharing mirror
|
4375
|
+
# reduces the network traffic to a FlexVol volume by providing
|
4376
|
+
# additional read-only access to clients.
|
4377
|
+
# @return [String]
|
4378
|
+
#
|
4379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapVolumeConfiguration AWS API Documentation
|
4380
|
+
#
|
4381
|
+
class OntapVolumeConfiguration < Struct.new(
|
4382
|
+
:flex_cache_endpoint_type,
|
4383
|
+
:junction_path,
|
4384
|
+
:security_style,
|
4385
|
+
:size_in_megabytes,
|
4386
|
+
:storage_efficiency_enabled,
|
4387
|
+
:storage_virtual_machine_id,
|
4388
|
+
:storage_virtual_machine_root,
|
4389
|
+
:tiering_policy,
|
4390
|
+
:uuid,
|
4391
|
+
:ontap_volume_type)
|
4392
|
+
SENSITIVE = []
|
4393
|
+
include Aws::Structure
|
4394
|
+
end
|
4395
|
+
|
3257
4396
|
# The resource specified does not support tagging.
|
3258
4397
|
#
|
3259
4398
|
# @!attribute [rw] resource_arn
|
@@ -3295,7 +4434,8 @@ module Aws::FSx
|
|
3295
4434
|
end
|
3296
4435
|
|
3297
4436
|
# The configuration of the self-managed Microsoft Active Directory (AD)
|
3298
|
-
# directory to which the Windows File Server
|
4437
|
+
# directory to which the Windows File Server or ONTAP storage virtual
|
4438
|
+
# machine (SVM) instance is joined.
|
3299
4439
|
#
|
3300
4440
|
# @!attribute [rw] domain_name
|
3301
4441
|
# The fully qualified domain name of the self-managed AD directory.
|
@@ -3304,7 +4444,7 @@ module Aws::FSx
|
|
3304
4444
|
# @!attribute [rw] organizational_unit_distinguished_name
|
3305
4445
|
# The fully qualified distinguished name of the organizational unit
|
3306
4446
|
# within the self-managed AD directory to which the Windows File
|
3307
|
-
# Server instance is joined.
|
4447
|
+
# Server or ONTAP storage virtual machine (SVM) instance is joined.
|
3308
4448
|
# @return [String]
|
3309
4449
|
#
|
3310
4450
|
# @!attribute [rw] file_system_administrators_group
|
@@ -3334,14 +4474,17 @@ module Aws::FSx
|
|
3334
4474
|
include Aws::Structure
|
3335
4475
|
end
|
3336
4476
|
|
3337
|
-
# The configuration that Amazon FSx uses to join
|
3338
|
-
#
|
4477
|
+
# The configuration that Amazon FSx uses to join a Amazon FSx for
|
4478
|
+
# Windows File Server file system or an ONTAP storage virtual machine
|
4479
|
+
# (SVM) to a self-managed (including on-premises) Microsoft Active
|
3339
4480
|
# Directory (AD) directory. For more information, see [ Using Amazon FSx
|
3340
|
-
# with your self-managed Microsoft Active Directory][1]
|
4481
|
+
# with your self-managed Microsoft Active Directory][1] or [Managing
|
4482
|
+
# SVMs][2].
|
3341
4483
|
#
|
3342
4484
|
#
|
3343
4485
|
#
|
3344
4486
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
|
4487
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html
|
3345
4488
|
#
|
3346
4489
|
# @note When making an API call, you may pass SelfManagedActiveDirectoryConfiguration
|
3347
4490
|
# data as a hash:
|
@@ -3362,12 +4505,11 @@ module Aws::FSx
|
|
3362
4505
|
#
|
3363
4506
|
# @!attribute [rw] organizational_unit_distinguished_name
|
3364
4507
|
# (Optional) The fully qualified distinguished name of the
|
3365
|
-
# organizational unit within your self-managed AD directory
|
3366
|
-
#
|
3367
|
-
#
|
3368
|
-
#
|
3369
|
-
#
|
3370
|
-
# default location of your self-managed AD directory.
|
4508
|
+
# organizational unit within your self-managed AD directory. Amazon
|
4509
|
+
# FSx only accepts OU as the direct parent of the file system. An
|
4510
|
+
# example is `OU=FSx,DC=yourdomain,DC=corp,DC=com`. To learn more, see
|
4511
|
+
# [RFC 2253][1]. If none is provided, the FSx file system is created
|
4512
|
+
# in the default location of your self-managed AD directory.
|
3371
4513
|
#
|
3372
4514
|
# Only Organizational Unit (OU) objects can be the direct parent of
|
3373
4515
|
# the file system that you're creating.
|
@@ -3460,7 +4602,8 @@ module Aws::FSx
|
|
3460
4602
|
end
|
3461
4603
|
|
3462
4604
|
# An error indicating that a particular service limit was exceeded. You
|
3463
|
-
# can increase some service limits by contacting
|
4605
|
+
# can increase some service limits by contacting Amazon Web Services
|
4606
|
+
# Support.
|
3464
4607
|
#
|
3465
4608
|
# @!attribute [rw] limit
|
3466
4609
|
# Enumeration of the service limit that was exceeded.
|
@@ -3499,96 +4642,370 @@ module Aws::FSx
|
|
3499
4642
|
include Aws::Structure
|
3500
4643
|
end
|
3501
4644
|
|
3502
|
-
#
|
4645
|
+
# Describes the Amazon FSx for NetApp ONTAP storage virtual machine
|
4646
|
+
# (SVM) configuraton.
|
3503
4647
|
#
|
3504
|
-
#
|
3505
|
-
#
|
4648
|
+
# @!attribute [rw] active_directory_configuration
|
4649
|
+
# Describes the Microsoft Active Directory configuration to which the
|
4650
|
+
# SVM is joined, if applicable.
|
4651
|
+
# @return [Types::SvmActiveDirectoryConfiguration]
|
3506
4652
|
#
|
3507
|
-
#
|
3508
|
-
#
|
3509
|
-
#
|
3510
|
-
#
|
4653
|
+
# @!attribute [rw] creation_time
|
4654
|
+
# The time that the resource was created, in seconds (since
|
4655
|
+
# 1970-01-01T00:00:00Z), also known as Unix time.
|
4656
|
+
# @return [Time]
|
3511
4657
|
#
|
3512
|
-
# @!attribute [rw]
|
3513
|
-
#
|
3514
|
-
#
|
4658
|
+
# @!attribute [rw] endpoints
|
4659
|
+
# The endpoints that are used to access data or to manage the SVM
|
4660
|
+
# using the NetApp ONTAP CLI, REST API, or NetApp CloudManager. They
|
4661
|
+
# are the `Iscsi`, `Management`, `Nfs`, and `Smb` endpoints.
|
4662
|
+
# @return [Types::SvmEndpoints]
|
4663
|
+
#
|
4664
|
+
# @!attribute [rw] file_system_id
|
4665
|
+
# The globally unique ID of the file system, assigned by Amazon FSx.
|
3515
4666
|
# @return [String]
|
3516
4667
|
#
|
3517
|
-
# @!attribute [rw]
|
3518
|
-
#
|
3519
|
-
#
|
3520
|
-
#
|
3521
|
-
#
|
4668
|
+
# @!attribute [rw] lifecycle
|
4669
|
+
# Describes the SVM's lifecycle status.
|
4670
|
+
#
|
4671
|
+
# * `CREATED` - The SVM is fully available for use.
|
4672
|
+
#
|
4673
|
+
# * `CREATING` - Amazon FSx is creating the new SVM.
|
4674
|
+
#
|
4675
|
+
# * `DELETING` - Amazon FSx is deleting an existing SVM.
|
4676
|
+
#
|
4677
|
+
# * `FAILED` - Amazon FSx was unable to create the SVM.
|
4678
|
+
#
|
4679
|
+
# * `MISCONFIGURED` - The SVM is in a failed but recoverable state.
|
4680
|
+
#
|
4681
|
+
# * `PENDING` - Amazon FSx has not started creating the SVM.
|
3522
4682
|
# @return [String]
|
3523
4683
|
#
|
3524
|
-
#
|
4684
|
+
# @!attribute [rw] name
|
4685
|
+
# The name of the SVM, if provisioned.
|
4686
|
+
# @return [String]
|
3525
4687
|
#
|
3526
|
-
|
3527
|
-
|
3528
|
-
|
4688
|
+
# @!attribute [rw] resource_arn
|
4689
|
+
# The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
|
4690
|
+
# identify Amazon Web Services resources. We require an ARN when you
|
4691
|
+
# need to specify a resource unambiguously across all of Amazon Web
|
4692
|
+
# Services. For more information, see [Amazon Resource Names
|
4693
|
+
# (ARNs)][1] in the *Amazon Web Services General Reference*.
|
4694
|
+
#
|
4695
|
+
#
|
4696
|
+
#
|
4697
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
4698
|
+
# @return [String]
|
4699
|
+
#
|
4700
|
+
# @!attribute [rw] storage_virtual_machine_id
|
4701
|
+
# The SVM's system generated unique ID.
|
4702
|
+
# @return [String]
|
4703
|
+
#
|
4704
|
+
# @!attribute [rw] subtype
|
4705
|
+
# Describes the SVM's subtype.
|
4706
|
+
# @return [String]
|
4707
|
+
#
|
4708
|
+
# @!attribute [rw] uuid
|
4709
|
+
# The SVM's UUID (universally unique identifier).
|
4710
|
+
# @return [String]
|
4711
|
+
#
|
4712
|
+
# @!attribute [rw] tags
|
4713
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
4714
|
+
# @return [Array<Types::Tag>]
|
4715
|
+
#
|
4716
|
+
# @!attribute [rw] lifecycle_transition_reason
|
4717
|
+
# Describes why the SVM lifecycle state changed.
|
4718
|
+
# @return [Types::LifecycleTransitionReason]
|
4719
|
+
#
|
4720
|
+
# @!attribute [rw] root_volume_security_style
|
4721
|
+
# The security style of the root volume of the SVM.
|
4722
|
+
# @return [String]
|
4723
|
+
#
|
4724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachine AWS API Documentation
|
4725
|
+
#
|
4726
|
+
class StorageVirtualMachine < Struct.new(
|
4727
|
+
:active_directory_configuration,
|
4728
|
+
:creation_time,
|
4729
|
+
:endpoints,
|
4730
|
+
:file_system_id,
|
4731
|
+
:lifecycle,
|
4732
|
+
:name,
|
4733
|
+
:resource_arn,
|
4734
|
+
:storage_virtual_machine_id,
|
4735
|
+
:subtype,
|
4736
|
+
:uuid,
|
4737
|
+
:tags,
|
4738
|
+
:lifecycle_transition_reason,
|
4739
|
+
:root_volume_security_style)
|
3529
4740
|
SENSITIVE = []
|
3530
4741
|
include Aws::Structure
|
3531
4742
|
end
|
3532
4743
|
|
3533
|
-
#
|
4744
|
+
# A filter used to restrict the results of describe calls for Amazon FSx
|
4745
|
+
# for NetApp ONTAP storage virtual machines (SVMs). You can use multiple
|
4746
|
+
# filters to return results that meet all applied filter requirements.
|
3534
4747
|
#
|
3535
|
-
# @note When making an API call, you may pass
|
4748
|
+
# @note When making an API call, you may pass StorageVirtualMachineFilter
|
3536
4749
|
# data as a hash:
|
3537
4750
|
#
|
3538
4751
|
# {
|
3539
|
-
#
|
3540
|
-
#
|
3541
|
-
# {
|
3542
|
-
# key: "TagKey", # required
|
3543
|
-
# value: "TagValue", # required
|
3544
|
-
# },
|
3545
|
-
# ],
|
4752
|
+
# name: "file-system-id", # accepts file-system-id
|
4753
|
+
# values: ["StorageVirtualMachineFilterValue"],
|
3546
4754
|
# }
|
3547
4755
|
#
|
3548
|
-
# @!attribute [rw]
|
3549
|
-
# The
|
3550
|
-
# want to tag.
|
4756
|
+
# @!attribute [rw] name
|
4757
|
+
# The name for this filter.
|
3551
4758
|
# @return [String]
|
3552
4759
|
#
|
3553
|
-
# @!attribute [rw]
|
3554
|
-
#
|
3555
|
-
#
|
3556
|
-
#
|
3557
|
-
# @return [Array<Types::Tag>]
|
4760
|
+
# @!attribute [rw] values
|
4761
|
+
# The values of the filter. These are all the values for any of the
|
4762
|
+
# applied filters.
|
4763
|
+
# @return [Array<String>]
|
3558
4764
|
#
|
3559
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/
|
4765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachineFilter AWS API Documentation
|
3560
4766
|
#
|
3561
|
-
class
|
3562
|
-
:
|
3563
|
-
:
|
4767
|
+
class StorageVirtualMachineFilter < Struct.new(
|
4768
|
+
:name,
|
4769
|
+
:values)
|
3564
4770
|
SENSITIVE = []
|
3565
4771
|
include Aws::Structure
|
3566
4772
|
end
|
3567
4773
|
|
3568
|
-
#
|
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.
|
4774
|
+
# No Amazon FSx for NetApp ONTAP SVMs were found based upon the supplied
|
4775
|
+
# parameters.
|
3575
4776
|
#
|
3576
4777
|
# @!attribute [rw] message
|
3577
4778
|
# A detailed error message.
|
3578
4779
|
# @return [String]
|
3579
4780
|
#
|
3580
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/
|
4781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/StorageVirtualMachineNotFound AWS API Documentation
|
3581
4782
|
#
|
3582
|
-
class
|
4783
|
+
class StorageVirtualMachineNotFound < Struct.new(
|
3583
4784
|
:message)
|
3584
4785
|
SENSITIVE = []
|
3585
4786
|
include Aws::Structure
|
3586
4787
|
end
|
3587
4788
|
|
3588
|
-
#
|
4789
|
+
# Describes the configuration of the Microsoft Active Directory (AD)
|
4790
|
+
# directory to which the Amazon FSx for ONTAP storage virtual machine
|
4791
|
+
# (SVM) is joined. Pleae note, account credentials are not returned in
|
4792
|
+
# the response payload.
|
3589
4793
|
#
|
3590
|
-
#
|
3591
|
-
#
|
4794
|
+
# @!attribute [rw] net_bios_name
|
4795
|
+
# The NetBIOS name of the Active Directory computer object that is
|
4796
|
+
# joined to your SVM.
|
4797
|
+
# @return [String]
|
4798
|
+
#
|
4799
|
+
# @!attribute [rw] self_managed_active_directory_configuration
|
4800
|
+
# The configuration of the self-managed Microsoft Active Directory
|
4801
|
+
# (AD) directory to which the Windows File Server or ONTAP storage
|
4802
|
+
# virtual machine (SVM) instance is joined.
|
4803
|
+
# @return [Types::SelfManagedActiveDirectoryAttributes]
|
4804
|
+
#
|
4805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmActiveDirectoryConfiguration AWS API Documentation
|
4806
|
+
#
|
4807
|
+
class SvmActiveDirectoryConfiguration < Struct.new(
|
4808
|
+
:net_bios_name,
|
4809
|
+
:self_managed_active_directory_configuration)
|
4810
|
+
SENSITIVE = []
|
4811
|
+
include Aws::Structure
|
4812
|
+
end
|
4813
|
+
|
4814
|
+
# An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has four
|
4815
|
+
# endpoints that are used to access data or to manage the SVM using the
|
4816
|
+
# NetApp ONTAP CLI, REST API, or NetApp CloudManager. They are the
|
4817
|
+
# `Iscsi`, `Management`, `Nfs`, and `Smb` endpoints.
|
4818
|
+
#
|
4819
|
+
# @!attribute [rw] dns_name
|
4820
|
+
# The Domain Name Service (DNS) name for the file system. You can
|
4821
|
+
# mount your file system using its DNS name.
|
4822
|
+
# @return [String]
|
4823
|
+
#
|
4824
|
+
# @!attribute [rw] ip_addresses
|
4825
|
+
# The SVM endpoint's IP addresses.
|
4826
|
+
# @return [Array<String>]
|
4827
|
+
#
|
4828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmEndpoint AWS API Documentation
|
4829
|
+
#
|
4830
|
+
class SvmEndpoint < Struct.new(
|
4831
|
+
:dns_name,
|
4832
|
+
:ip_addresses)
|
4833
|
+
SENSITIVE = []
|
4834
|
+
include Aws::Structure
|
4835
|
+
end
|
4836
|
+
|
4837
|
+
# An Amazon FSx for NetApp ONTAP storage virtual machine (SVM) has the
|
4838
|
+
# following endpoints that are used to access data or to manage the SVM
|
4839
|
+
# using the NetApp ONTAP CLI, REST API, or NetApp CloudManager.
|
4840
|
+
#
|
4841
|
+
# @!attribute [rw] iscsi
|
4842
|
+
# An endpoint for connecting using the Internet Small Computer Systems
|
4843
|
+
# Interface (iSCSI) protocol.
|
4844
|
+
# @return [Types::SvmEndpoint]
|
4845
|
+
#
|
4846
|
+
# @!attribute [rw] management
|
4847
|
+
# An endpoint for managing SVMs using the NetApp ONTAP CLI, NetApp
|
4848
|
+
# ONTAP API, or NetApp CloudManager.
|
4849
|
+
# @return [Types::SvmEndpoint]
|
4850
|
+
#
|
4851
|
+
# @!attribute [rw] nfs
|
4852
|
+
# An endpoint for connecting using the Network File System (NFS)
|
4853
|
+
# protocol.
|
4854
|
+
# @return [Types::SvmEndpoint]
|
4855
|
+
#
|
4856
|
+
# @!attribute [rw] smb
|
4857
|
+
# An endpoint for connecting using the Server Message Block (SMB)
|
4858
|
+
# protocol.
|
4859
|
+
# @return [Types::SvmEndpoint]
|
4860
|
+
#
|
4861
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SvmEndpoints AWS API Documentation
|
4862
|
+
#
|
4863
|
+
class SvmEndpoints < Struct.new(
|
4864
|
+
:iscsi,
|
4865
|
+
:management,
|
4866
|
+
:nfs,
|
4867
|
+
:smb)
|
4868
|
+
SENSITIVE = []
|
4869
|
+
include Aws::Structure
|
4870
|
+
end
|
4871
|
+
|
4872
|
+
# Specifies a key-value pair for a resource tag.
|
4873
|
+
#
|
4874
|
+
# @note When making an API call, you may pass Tag
|
4875
|
+
# data as a hash:
|
4876
|
+
#
|
4877
|
+
# {
|
4878
|
+
# key: "TagKey", # required
|
4879
|
+
# value: "TagValue", # required
|
4880
|
+
# }
|
4881
|
+
#
|
4882
|
+
# @!attribute [rw] key
|
4883
|
+
# A value that specifies the `TagKey`, the name of the tag. Tag keys
|
4884
|
+
# must be unique for the resource to which they are attached.
|
4885
|
+
# @return [String]
|
4886
|
+
#
|
4887
|
+
# @!attribute [rw] value
|
4888
|
+
# A value that specifies the `TagValue`, the value assigned to the
|
4889
|
+
# corresponding tag key. Tag values can be null and don't have to be
|
4890
|
+
# unique in a tag set. For example, you can have a key-value pair in a
|
4891
|
+
# tag set of `finances : April` and also of `payroll : April`.
|
4892
|
+
# @return [String]
|
4893
|
+
#
|
4894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Tag AWS API Documentation
|
4895
|
+
#
|
4896
|
+
class Tag < Struct.new(
|
4897
|
+
:key,
|
4898
|
+
:value)
|
4899
|
+
SENSITIVE = []
|
4900
|
+
include Aws::Structure
|
4901
|
+
end
|
4902
|
+
|
4903
|
+
# The request object for the `TagResource` operation.
|
4904
|
+
#
|
4905
|
+
# @note When making an API call, you may pass TagResourceRequest
|
4906
|
+
# data as a hash:
|
4907
|
+
#
|
4908
|
+
# {
|
4909
|
+
# resource_arn: "ResourceARN", # required
|
4910
|
+
# tags: [ # required
|
4911
|
+
# {
|
4912
|
+
# key: "TagKey", # required
|
4913
|
+
# value: "TagValue", # required
|
4914
|
+
# },
|
4915
|
+
# ],
|
4916
|
+
# }
|
4917
|
+
#
|
4918
|
+
# @!attribute [rw] resource_arn
|
4919
|
+
# The Amazon Resource Name (ARN) of the Amazon FSx resource that you
|
4920
|
+
# want to tag.
|
4921
|
+
# @return [String]
|
4922
|
+
#
|
4923
|
+
# @!attribute [rw] tags
|
4924
|
+
# A list of tags for the resource. If a tag with a given key already
|
4925
|
+
# exists, the value is replaced by the one specified in this
|
4926
|
+
# parameter.
|
4927
|
+
# @return [Array<Types::Tag>]
|
4928
|
+
#
|
4929
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceRequest AWS API Documentation
|
4930
|
+
#
|
4931
|
+
class TagResourceRequest < Struct.new(
|
4932
|
+
:resource_arn,
|
4933
|
+
:tags)
|
4934
|
+
SENSITIVE = []
|
4935
|
+
include Aws::Structure
|
4936
|
+
end
|
4937
|
+
|
4938
|
+
# The response object for the `TagResource` operation.
|
4939
|
+
#
|
4940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceResponse AWS API Documentation
|
4941
|
+
#
|
4942
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
4943
|
+
|
4944
|
+
# Describes the data tiering policy for an ONTAP volume. When enabled,
|
4945
|
+
# Amazon FSx for ONTAP's intelligent tiering automatically transitions
|
4946
|
+
# a volume's data between the file system's primary storage and
|
4947
|
+
# capacity pool storage based on your access patterns.
|
4948
|
+
#
|
4949
|
+
# @note When making an API call, you may pass TieringPolicy
|
4950
|
+
# data as a hash:
|
4951
|
+
#
|
4952
|
+
# {
|
4953
|
+
# cooling_period: 1,
|
4954
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
4955
|
+
# }
|
4956
|
+
#
|
4957
|
+
# @!attribute [rw] cooling_period
|
4958
|
+
# Specifies the number of days that user data in a volume must remain
|
4959
|
+
# inactive before it is considered "cold" and moved to the capacity
|
4960
|
+
# pool. Used with the `AUTO` and `SNAPSHOT_ONLY` tiering policies.
|
4961
|
+
# Enter a whole number between 2 and 183. Default values are 31 days
|
4962
|
+
# for `AUTO` and 2 days for `SNAPSHOT_ONLY`.
|
4963
|
+
# @return [Integer]
|
4964
|
+
#
|
4965
|
+
# @!attribute [rw] name
|
4966
|
+
# Specifies the tiering policy used to transition data. Default value
|
4967
|
+
# is `SNAPSHOT_ONLY`.
|
4968
|
+
#
|
4969
|
+
# * `SNAPSHOT_ONLY` - moves cold snapshots to the capacity pool
|
4970
|
+
# storage tier.
|
4971
|
+
#
|
4972
|
+
# * `AUTO` - moves cold user data and snapshots to the capacity pool
|
4973
|
+
# storage tier based on your access patterns.
|
4974
|
+
#
|
4975
|
+
# * `ALL` - moves all user data blocks in both the active file system
|
4976
|
+
# and Snapshot copies to the storage pool tier.
|
4977
|
+
#
|
4978
|
+
# * `NONE` - keeps a volume's data in the primary storage tier,
|
4979
|
+
# preventing it from being moved to the capacity pool tier.
|
4980
|
+
# @return [String]
|
4981
|
+
#
|
4982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TieringPolicy AWS API Documentation
|
4983
|
+
#
|
4984
|
+
class TieringPolicy < Struct.new(
|
4985
|
+
:cooling_period,
|
4986
|
+
:name)
|
4987
|
+
SENSITIVE = []
|
4988
|
+
include Aws::Structure
|
4989
|
+
end
|
4990
|
+
|
4991
|
+
# The requested operation is not supported for this resource or API.
|
4992
|
+
#
|
4993
|
+
# @!attribute [rw] message
|
4994
|
+
# A detailed error message.
|
4995
|
+
# @return [String]
|
4996
|
+
#
|
4997
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UnsupportedOperation AWS API Documentation
|
4998
|
+
#
|
4999
|
+
class UnsupportedOperation < Struct.new(
|
5000
|
+
:message)
|
5001
|
+
SENSITIVE = []
|
5002
|
+
include Aws::Structure
|
5003
|
+
end
|
5004
|
+
|
5005
|
+
# The request object for `UntagResource` action.
|
5006
|
+
#
|
5007
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
5008
|
+
# data as a hash:
|
3592
5009
|
#
|
3593
5010
|
# {
|
3594
5011
|
# resource_arn: "ResourceARN", # required
|
@@ -3710,6 +5127,63 @@ module Aws::FSx
|
|
3710
5127
|
include Aws::Structure
|
3711
5128
|
end
|
3712
5129
|
|
5130
|
+
# The configuration updates for an Amazon FSx for NetApp ONTAP file
|
5131
|
+
# system.
|
5132
|
+
#
|
5133
|
+
# @note When making an API call, you may pass UpdateFileSystemOntapConfiguration
|
5134
|
+
# data as a hash:
|
5135
|
+
#
|
5136
|
+
# {
|
5137
|
+
# automatic_backup_retention_days: 1,
|
5138
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
5139
|
+
# fsx_admin_password: "AdminPassword",
|
5140
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
5141
|
+
# }
|
5142
|
+
#
|
5143
|
+
# @!attribute [rw] automatic_backup_retention_days
|
5144
|
+
# The number of days to retain automatic backups. Setting this to 0
|
5145
|
+
# disables automatic backups. You can retain automatic backups for a
|
5146
|
+
# maximum of 90 days. The default is 0.
|
5147
|
+
# @return [Integer]
|
5148
|
+
#
|
5149
|
+
# @!attribute [rw] daily_automatic_backup_start_time
|
5150
|
+
# A recurring daily time, in the format `HH:MM`. `HH` is the
|
5151
|
+
# zero-padded hour of the day (0-23), and `MM` is the zero-padded
|
5152
|
+
# minute of the hour. For example, `05:00` specifies 5 AM daily.
|
5153
|
+
# @return [String]
|
5154
|
+
#
|
5155
|
+
# @!attribute [rw] fsx_admin_password
|
5156
|
+
# The ONTAP administrative password for the `fsxadmin` user.
|
5157
|
+
# @return [String]
|
5158
|
+
#
|
5159
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
5160
|
+
# A recurring weekly time, in the format `D:HH:MM`.
|
5161
|
+
#
|
5162
|
+
# `D` is the day of the week, for which 1 represents Monday and 7
|
5163
|
+
# represents Sunday. For further details, see [the ISO-8601 spec as
|
5164
|
+
# described on Wikipedia][1].
|
5165
|
+
#
|
5166
|
+
# `HH` is the zero-padded hour of the day (0-23), and `MM` is the
|
5167
|
+
# zero-padded minute of the hour.
|
5168
|
+
#
|
5169
|
+
# For example, `1:05:00` specifies maintenance at 5 AM Monday.
|
5170
|
+
#
|
5171
|
+
#
|
5172
|
+
#
|
5173
|
+
# [1]: https://en.wikipedia.org/wiki/ISO_week_date
|
5174
|
+
# @return [String]
|
5175
|
+
#
|
5176
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemOntapConfiguration AWS API Documentation
|
5177
|
+
#
|
5178
|
+
class UpdateFileSystemOntapConfiguration < Struct.new(
|
5179
|
+
:automatic_backup_retention_days,
|
5180
|
+
:daily_automatic_backup_start_time,
|
5181
|
+
:fsx_admin_password,
|
5182
|
+
:weekly_maintenance_start_time)
|
5183
|
+
SENSITIVE = [:fsx_admin_password]
|
5184
|
+
include Aws::Structure
|
5185
|
+
end
|
5186
|
+
|
3713
5187
|
# The request object for the `UpdateFileSystem` operation.
|
3714
5188
|
#
|
3715
5189
|
# @note When making an API call, you may pass UpdateFileSystemRequest
|
@@ -3742,6 +5216,12 @@ module Aws::FSx
|
|
3742
5216
|
# auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED
|
3743
5217
|
# data_compression_type: "NONE", # accepts NONE, LZ4
|
3744
5218
|
# },
|
5219
|
+
# ontap_configuration: {
|
5220
|
+
# automatic_backup_retention_days: 1,
|
5221
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
5222
|
+
# fsx_admin_password: "AdminPassword",
|
5223
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
5224
|
+
# },
|
3745
5225
|
# }
|
3746
5226
|
#
|
3747
5227
|
# @!attribute [rw] file_system_id
|
@@ -3751,8 +5231,8 @@ module Aws::FSx
|
|
3751
5231
|
# @!attribute [rw] client_request_token
|
3752
5232
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
3753
5233
|
# idempotent updates. This string is automatically filled on your
|
3754
|
-
# behalf when you use the
|
3755
|
-
#
|
5234
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon
|
5235
|
+
# Web Services SDK.
|
3756
5236
|
#
|
3757
5237
|
# **A suitable default value is auto-generated.** You should normally
|
3758
5238
|
# not need to pass this option.
|
@@ -3760,10 +5240,11 @@ module Aws::FSx
|
|
3760
5240
|
#
|
3761
5241
|
# @!attribute [rw] storage_capacity
|
3762
5242
|
# Use this parameter to increase the storage capacity of an Amazon FSx
|
3763
|
-
#
|
3764
|
-
#
|
3765
|
-
#
|
3766
|
-
#
|
5243
|
+
# for Windows File Server or Amazon FSx for Lustre file system.
|
5244
|
+
# Specifies the storage capacity target value, GiB, to increase the
|
5245
|
+
# storage capacity for the file system that you're updating. You
|
5246
|
+
# cannot make a storage capacity increase request if there is an
|
5247
|
+
# existing storage capacity increase request in progress.
|
3767
5248
|
#
|
3768
5249
|
# For Windows file systems, the storage capacity target value must be
|
3769
5250
|
# at least 10 percent (%) greater than the current storage capacity
|
@@ -3806,6 +5287,11 @@ module Aws::FSx
|
|
3806
5287
|
# in the `UpdateFileSystem` operation.
|
3807
5288
|
# @return [Types::UpdateFileSystemLustreConfiguration]
|
3808
5289
|
#
|
5290
|
+
# @!attribute [rw] ontap_configuration
|
5291
|
+
# The configuration updates for an Amazon FSx for NetApp ONTAP file
|
5292
|
+
# system.
|
5293
|
+
# @return [Types::UpdateFileSystemOntapConfiguration]
|
5294
|
+
#
|
3809
5295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemRequest AWS API Documentation
|
3810
5296
|
#
|
3811
5297
|
class UpdateFileSystemRequest < Struct.new(
|
@@ -3813,7 +5299,8 @@ module Aws::FSx
|
|
3813
5299
|
:client_request_token,
|
3814
5300
|
:storage_capacity,
|
3815
5301
|
:windows_configuration,
|
3816
|
-
:lustre_configuration
|
5302
|
+
:lustre_configuration,
|
5303
|
+
:ontap_configuration)
|
3817
5304
|
SENSITIVE = []
|
3818
5305
|
include Aws::Structure
|
3819
5306
|
end
|
@@ -3917,6 +5404,338 @@ module Aws::FSx
|
|
3917
5404
|
include Aws::Structure
|
3918
5405
|
end
|
3919
5406
|
|
5407
|
+
# Used to specify changes to the ONTAP configuration for the volume you
|
5408
|
+
# are updating.
|
5409
|
+
#
|
5410
|
+
# @note When making an API call, you may pass UpdateOntapVolumeConfiguration
|
5411
|
+
# data as a hash:
|
5412
|
+
#
|
5413
|
+
# {
|
5414
|
+
# junction_path: "JunctionPath",
|
5415
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
5416
|
+
# size_in_megabytes: 1,
|
5417
|
+
# storage_efficiency_enabled: false,
|
5418
|
+
# tiering_policy: {
|
5419
|
+
# cooling_period: 1,
|
5420
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
5421
|
+
# },
|
5422
|
+
# }
|
5423
|
+
#
|
5424
|
+
# @!attribute [rw] junction_path
|
5425
|
+
# Specifies the location in the SVM's namespace where the volume is
|
5426
|
+
# mounted. The `JunctionPath` must have a leading forward slash, such
|
5427
|
+
# as `/vol3`.
|
5428
|
+
# @return [String]
|
5429
|
+
#
|
5430
|
+
# @!attribute [rw] security_style
|
5431
|
+
# The security style for the volume, which can be `UNIX`. `NTFS`, or
|
5432
|
+
# `MIXED`.
|
5433
|
+
# @return [String]
|
5434
|
+
#
|
5435
|
+
# @!attribute [rw] size_in_megabytes
|
5436
|
+
# Specifies the size of the volume in megabytes.
|
5437
|
+
# @return [Integer]
|
5438
|
+
#
|
5439
|
+
# @!attribute [rw] storage_efficiency_enabled
|
5440
|
+
# Default is `false`. Set to true to enable the deduplication,
|
5441
|
+
# compression, and compaction storage efficiency features on the
|
5442
|
+
# volume.
|
5443
|
+
# @return [Boolean]
|
5444
|
+
#
|
5445
|
+
# @!attribute [rw] tiering_policy
|
5446
|
+
# Update the volume's data tiering policy.
|
5447
|
+
# @return [Types::TieringPolicy]
|
5448
|
+
#
|
5449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateOntapVolumeConfiguration AWS API Documentation
|
5450
|
+
#
|
5451
|
+
class UpdateOntapVolumeConfiguration < Struct.new(
|
5452
|
+
:junction_path,
|
5453
|
+
:security_style,
|
5454
|
+
:size_in_megabytes,
|
5455
|
+
:storage_efficiency_enabled,
|
5456
|
+
:tiering_policy)
|
5457
|
+
SENSITIVE = []
|
5458
|
+
include Aws::Structure
|
5459
|
+
end
|
5460
|
+
|
5461
|
+
# @note When making an API call, you may pass UpdateStorageVirtualMachineRequest
|
5462
|
+
# data as a hash:
|
5463
|
+
#
|
5464
|
+
# {
|
5465
|
+
# active_directory_configuration: {
|
5466
|
+
# self_managed_active_directory_configuration: {
|
5467
|
+
# user_name: "DirectoryUserName",
|
5468
|
+
# password: "DirectoryPassword",
|
5469
|
+
# dns_ips: ["IpAddress"],
|
5470
|
+
# },
|
5471
|
+
# },
|
5472
|
+
# client_request_token: "ClientRequestToken",
|
5473
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
5474
|
+
# svm_admin_password: "AdminPassword",
|
5475
|
+
# }
|
5476
|
+
#
|
5477
|
+
# @!attribute [rw] active_directory_configuration
|
5478
|
+
# Updates the Microsoft Active Directory (AD) configuration for an SVM
|
5479
|
+
# that is joined to an AD.
|
5480
|
+
# @return [Types::UpdateSvmActiveDirectoryConfiguration]
|
5481
|
+
#
|
5482
|
+
# @!attribute [rw] client_request_token
|
5483
|
+
# (Optional) An idempotency token for resource creation, in a string
|
5484
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
5485
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
5486
|
+
# Amazon Web Services SDK.
|
5487
|
+
#
|
5488
|
+
# **A suitable default value is auto-generated.** You should normally
|
5489
|
+
# not need to pass this option.
|
5490
|
+
# @return [String]
|
5491
|
+
#
|
5492
|
+
# @!attribute [rw] storage_virtual_machine_id
|
5493
|
+
# The ID of the SVM that you want to update, in the format
|
5494
|
+
# `svm-0123456789abcdef0`.
|
5495
|
+
# @return [String]
|
5496
|
+
#
|
5497
|
+
# @!attribute [rw] svm_admin_password
|
5498
|
+
# Enter a new SvmAdminPassword if you are updating it.
|
5499
|
+
# @return [String]
|
5500
|
+
#
|
5501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachineRequest AWS API Documentation
|
5502
|
+
#
|
5503
|
+
class UpdateStorageVirtualMachineRequest < Struct.new(
|
5504
|
+
:active_directory_configuration,
|
5505
|
+
:client_request_token,
|
5506
|
+
:storage_virtual_machine_id,
|
5507
|
+
:svm_admin_password)
|
5508
|
+
SENSITIVE = [:svm_admin_password]
|
5509
|
+
include Aws::Structure
|
5510
|
+
end
|
5511
|
+
|
5512
|
+
# @!attribute [rw] storage_virtual_machine
|
5513
|
+
# Describes the Amazon FSx for NetApp ONTAP storage virtual machine
|
5514
|
+
# (SVM) configuraton.
|
5515
|
+
# @return [Types::StorageVirtualMachine]
|
5516
|
+
#
|
5517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachineResponse AWS API Documentation
|
5518
|
+
#
|
5519
|
+
class UpdateStorageVirtualMachineResponse < Struct.new(
|
5520
|
+
:storage_virtual_machine)
|
5521
|
+
SENSITIVE = []
|
5522
|
+
include Aws::Structure
|
5523
|
+
end
|
5524
|
+
|
5525
|
+
# Updates the Microsoft Active Directory (AD) configuration of an SVM
|
5526
|
+
# joined to an AD. Pleae note, account credentials are not returned in
|
5527
|
+
# the response payload.
|
5528
|
+
#
|
5529
|
+
# @note When making an API call, you may pass UpdateSvmActiveDirectoryConfiguration
|
5530
|
+
# data as a hash:
|
5531
|
+
#
|
5532
|
+
# {
|
5533
|
+
# self_managed_active_directory_configuration: {
|
5534
|
+
# user_name: "DirectoryUserName",
|
5535
|
+
# password: "DirectoryPassword",
|
5536
|
+
# dns_ips: ["IpAddress"],
|
5537
|
+
# },
|
5538
|
+
# }
|
5539
|
+
#
|
5540
|
+
# @!attribute [rw] self_managed_active_directory_configuration
|
5541
|
+
# The configuration that Amazon FSx uses to join the Windows File
|
5542
|
+
# Server instance to a self-managed Microsoft Active Directory (AD)
|
5543
|
+
# directory.
|
5544
|
+
# @return [Types::SelfManagedActiveDirectoryConfigurationUpdates]
|
5545
|
+
#
|
5546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSvmActiveDirectoryConfiguration AWS API Documentation
|
5547
|
+
#
|
5548
|
+
class UpdateSvmActiveDirectoryConfiguration < Struct.new(
|
5549
|
+
:self_managed_active_directory_configuration)
|
5550
|
+
SENSITIVE = []
|
5551
|
+
include Aws::Structure
|
5552
|
+
end
|
5553
|
+
|
5554
|
+
# @note When making an API call, you may pass UpdateVolumeRequest
|
5555
|
+
# data as a hash:
|
5556
|
+
#
|
5557
|
+
# {
|
5558
|
+
# client_request_token: "ClientRequestToken",
|
5559
|
+
# volume_id: "VolumeId", # required
|
5560
|
+
# ontap_configuration: {
|
5561
|
+
# junction_path: "JunctionPath",
|
5562
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
5563
|
+
# size_in_megabytes: 1,
|
5564
|
+
# storage_efficiency_enabled: false,
|
5565
|
+
# tiering_policy: {
|
5566
|
+
# cooling_period: 1,
|
5567
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
5568
|
+
# },
|
5569
|
+
# },
|
5570
|
+
# }
|
5571
|
+
#
|
5572
|
+
# @!attribute [rw] client_request_token
|
5573
|
+
# (Optional) An idempotency token for resource creation, in a string
|
5574
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
5575
|
+
# your behalf when you use the Command Line Interface (CLI) or an
|
5576
|
+
# Amazon Web Services SDK.
|
5577
|
+
#
|
5578
|
+
# **A suitable default value is auto-generated.** You should normally
|
5579
|
+
# not need to pass this option.
|
5580
|
+
# @return [String]
|
5581
|
+
#
|
5582
|
+
# @!attribute [rw] volume_id
|
5583
|
+
# Specifies the volume that you want to update, formatted
|
5584
|
+
# `fsvol-0123456789abcdef0`.
|
5585
|
+
# @return [String]
|
5586
|
+
#
|
5587
|
+
# @!attribute [rw] ontap_configuration
|
5588
|
+
# The `ONTAP` configuration of the volume you are updating.
|
5589
|
+
# @return [Types::UpdateOntapVolumeConfiguration]
|
5590
|
+
#
|
5591
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolumeRequest AWS API Documentation
|
5592
|
+
#
|
5593
|
+
class UpdateVolumeRequest < Struct.new(
|
5594
|
+
:client_request_token,
|
5595
|
+
:volume_id,
|
5596
|
+
:ontap_configuration)
|
5597
|
+
SENSITIVE = []
|
5598
|
+
include Aws::Structure
|
5599
|
+
end
|
5600
|
+
|
5601
|
+
# @!attribute [rw] volume
|
5602
|
+
# Returned after a successful `UpdateVolume` API operation, describing
|
5603
|
+
# the volume just updated.
|
5604
|
+
# @return [Types::Volume]
|
5605
|
+
#
|
5606
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolumeResponse AWS API Documentation
|
5607
|
+
#
|
5608
|
+
class UpdateVolumeResponse < Struct.new(
|
5609
|
+
:volume)
|
5610
|
+
SENSITIVE = []
|
5611
|
+
include Aws::Structure
|
5612
|
+
end
|
5613
|
+
|
5614
|
+
# Describes an Amazon FSx for NetApp ONTAP volume.
|
5615
|
+
#
|
5616
|
+
# @!attribute [rw] creation_time
|
5617
|
+
# The time that the resource was created, in seconds (since
|
5618
|
+
# 1970-01-01T00:00:00Z), also known as Unix time.
|
5619
|
+
# @return [Time]
|
5620
|
+
#
|
5621
|
+
# @!attribute [rw] file_system_id
|
5622
|
+
# The globally unique ID of the file system, assigned by Amazon FSx.
|
5623
|
+
# @return [String]
|
5624
|
+
#
|
5625
|
+
# @!attribute [rw] lifecycle
|
5626
|
+
# The lifecycle status of the volume.
|
5627
|
+
#
|
5628
|
+
# * `CREATED` - The volume is fully available for use.
|
5629
|
+
#
|
5630
|
+
# * `CREATING` - Amazon FSx is creating the new volume.
|
5631
|
+
#
|
5632
|
+
# * `DELETING` - Amazon FSx is deleting an existing volume.
|
5633
|
+
#
|
5634
|
+
# * `FAILED` - Amazon FSx was unable to create the volume.
|
5635
|
+
#
|
5636
|
+
# * `MISCONFIGURED` - The volume is in a failed but recoverable state.
|
5637
|
+
#
|
5638
|
+
# * `PENDING` - Amazon FSx has not started creating the volume.
|
5639
|
+
# @return [String]
|
5640
|
+
#
|
5641
|
+
# @!attribute [rw] name
|
5642
|
+
# The name of the volume.
|
5643
|
+
# @return [String]
|
5644
|
+
#
|
5645
|
+
# @!attribute [rw] ontap_configuration
|
5646
|
+
# The configuration of an Amazon FSx for NetApp ONTAP volume
|
5647
|
+
# @return [Types::OntapVolumeConfiguration]
|
5648
|
+
#
|
5649
|
+
# @!attribute [rw] resource_arn
|
5650
|
+
# The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
|
5651
|
+
# identify Amazon Web Services resources. We require an ARN when you
|
5652
|
+
# need to specify a resource unambiguously across all of Amazon Web
|
5653
|
+
# Services. For more information, see [Amazon Resource Names
|
5654
|
+
# (ARNs)][1] in the *Amazon Web Services General Reference*.
|
5655
|
+
#
|
5656
|
+
#
|
5657
|
+
#
|
5658
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
5659
|
+
# @return [String]
|
5660
|
+
#
|
5661
|
+
# @!attribute [rw] tags
|
5662
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
5663
|
+
# @return [Array<Types::Tag>]
|
5664
|
+
#
|
5665
|
+
# @!attribute [rw] volume_id
|
5666
|
+
# The system-generated, unique ID of the volume.
|
5667
|
+
# @return [String]
|
5668
|
+
#
|
5669
|
+
# @!attribute [rw] volume_type
|
5670
|
+
# The type of volume; `ONTAP` is the only valid volume type.
|
5671
|
+
# @return [String]
|
5672
|
+
#
|
5673
|
+
# @!attribute [rw] lifecycle_transition_reason
|
5674
|
+
# Describes why the volume lifecycle state changed.
|
5675
|
+
# @return [Types::LifecycleTransitionReason]
|
5676
|
+
#
|
5677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Volume AWS API Documentation
|
5678
|
+
#
|
5679
|
+
class Volume < Struct.new(
|
5680
|
+
:creation_time,
|
5681
|
+
:file_system_id,
|
5682
|
+
:lifecycle,
|
5683
|
+
:name,
|
5684
|
+
:ontap_configuration,
|
5685
|
+
:resource_arn,
|
5686
|
+
:tags,
|
5687
|
+
:volume_id,
|
5688
|
+
:volume_type,
|
5689
|
+
:lifecycle_transition_reason)
|
5690
|
+
SENSITIVE = []
|
5691
|
+
include Aws::Structure
|
5692
|
+
end
|
5693
|
+
|
5694
|
+
# A filter used to restrict the results of describe calls for Amazon FSx
|
5695
|
+
# for NetApp ONTAP volumes. You can use multiple filters to return
|
5696
|
+
# results that meet all applied filter requirements.
|
5697
|
+
#
|
5698
|
+
# @note When making an API call, you may pass VolumeFilter
|
5699
|
+
# data as a hash:
|
5700
|
+
#
|
5701
|
+
# {
|
5702
|
+
# name: "file-system-id", # accepts file-system-id, storage-virtual-machine-id
|
5703
|
+
# values: ["VolumeFilterValue"],
|
5704
|
+
# }
|
5705
|
+
#
|
5706
|
+
# @!attribute [rw] name
|
5707
|
+
# The name for this filter.
|
5708
|
+
# @return [String]
|
5709
|
+
#
|
5710
|
+
# @!attribute [rw] values
|
5711
|
+
# The values of the filter. These are all the values for any of the
|
5712
|
+
# applied filters.
|
5713
|
+
# @return [Array<String>]
|
5714
|
+
#
|
5715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/VolumeFilter AWS API Documentation
|
5716
|
+
#
|
5717
|
+
class VolumeFilter < Struct.new(
|
5718
|
+
:name,
|
5719
|
+
:values)
|
5720
|
+
SENSITIVE = []
|
5721
|
+
include Aws::Structure
|
5722
|
+
end
|
5723
|
+
|
5724
|
+
# No Amazon FSx for NetApp ONTAP volumes were found based upon the
|
5725
|
+
# supplied parameters.
|
5726
|
+
#
|
5727
|
+
# @!attribute [rw] message
|
5728
|
+
# A detailed error message.
|
5729
|
+
# @return [String]
|
5730
|
+
#
|
5731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/VolumeNotFound AWS API Documentation
|
5732
|
+
#
|
5733
|
+
class VolumeNotFound < Struct.new(
|
5734
|
+
:message)
|
5735
|
+
SENSITIVE = []
|
5736
|
+
include Aws::Structure
|
5737
|
+
end
|
5738
|
+
|
3920
5739
|
# The configuration that Amazon FSx for Windows File Server uses to
|
3921
5740
|
# audit and log user accesses of files, folders, and file shares on the
|
3922
5741
|
# Amazon FSx for Windows File Server file system. For more information,
|
@@ -3968,8 +5787,9 @@ module Aws::FSx
|
|
3968
5787
|
# delivery stream must begin with the `aws-fsx` prefix.
|
3969
5788
|
#
|
3970
5789
|
# The destination ARN (either CloudWatch Logs log group or Kinesis
|
3971
|
-
# Data Firehose delivery stream) must be in the same
|
3972
|
-
#
|
5790
|
+
# Data Firehose delivery stream) must be in the same Amazon Web
|
5791
|
+
# Services partition, Amazon Web Services Region, and Amazon Web
|
5792
|
+
# Services account as your Amazon FSx file system.
|
3973
5793
|
# @return [String]
|
3974
5794
|
#
|
3975
5795
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsAuditLogConfiguration AWS API Documentation
|
@@ -4036,8 +5856,8 @@ module Aws::FSx
|
|
4036
5856
|
#
|
4037
5857
|
# * The destination ARN that you provide (either CloudWatch Logs log
|
4038
5858
|
# group or Kinesis Data Firehose delivery stream) must be in the
|
4039
|
-
# same
|
4040
|
-
# file system.
|
5859
|
+
# same Amazon Web Services partition, Amazon Web Services Region,
|
5860
|
+
# and Amazon Web Services account as your Amazon FSx file system.
|
4041
5861
|
#
|
4042
5862
|
# * The name of the Amazon CloudWatch Logs log group must begin with
|
4043
5863
|
# the `/aws/fsx` prefix. The name of the Amazon Kinesis Data
|
@@ -4068,13 +5888,14 @@ module Aws::FSx
|
|
4068
5888
|
# The configuration for this Microsoft Windows file system.
|
4069
5889
|
#
|
4070
5890
|
# @!attribute [rw] active_directory_id
|
4071
|
-
# The ID for an existing
|
4072
|
-
# instance that the file system is joined to.
|
5891
|
+
# The ID for an existing Amazon Web Services Managed Microsoft Active
|
5892
|
+
# Directory instance that the file system is joined to.
|
4073
5893
|
# @return [String]
|
4074
5894
|
#
|
4075
5895
|
# @!attribute [rw] self_managed_active_directory_configuration
|
4076
5896
|
# The configuration of the self-managed Microsoft Active Directory
|
4077
|
-
# (AD) directory to which the Windows File Server
|
5897
|
+
# (AD) directory to which the Windows File Server or ONTAP storage
|
5898
|
+
# virtual machine (SVM) instance is joined.
|
4078
5899
|
# @return [Types::SelfManagedActiveDirectoryAttributes]
|
4079
5900
|
#
|
4080
5901
|
# @!attribute [rw] deployment_type
|