aws-sdk-fsx 1.31.0 → 1.36.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -22,11 +22,24 @@ module Aws::FSx
22
22
  # which the file system is joined.
23
23
  # @return [String]
24
24
  #
25
+ # @!attribute [rw] resource_arn
26
+ # The Amazon Resource Name (ARN) for a given resource. ARNs uniquely
27
+ # identify AWS resources. We require an ARN when you need to specify a
28
+ # resource unambiguously across all of AWS. For more information, see
29
+ # [Amazon Resource Names (ARNs) and AWS Service Namespaces][1] in the
30
+ # *AWS General Reference*.
31
+ #
32
+ #
33
+ #
34
+ # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
35
+ # @return [String]
36
+ #
25
37
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ActiveDirectoryBackupAttributes AWS API Documentation
26
38
  #
27
39
  class ActiveDirectoryBackupAttributes < Struct.new(
28
40
  :domain_name,
29
- :active_directory_id)
41
+ :active_directory_id,
42
+ :resource_arn)
30
43
  SENSITIVE = []
31
44
  include Aws::Structure
32
45
  end
@@ -55,34 +68,52 @@ module Aws::FSx
55
68
  include Aws::Structure
56
69
  end
57
70
 
58
- # Describes a specific Amazon FSx Administrative Action for the current
59
- # Windows file system.
71
+ # Describes a specific Amazon FSx administrative action for the current
72
+ # Windows or Lustre file system.
60
73
  #
61
74
  # @!attribute [rw] administrative_action_type
62
75
  # Describes the type of administrative action, as follows:
63
76
  #
64
77
  # * `FILE_SYSTEM_UPDATE` - A file system update administrative action
65
78
  # initiated by the user from the Amazon FSx console, API
66
- # (UpdateFileSystem), or CLI (update-file-system). A
79
+ # (UpdateFileSystem), or CLI (update-file-system).
67
80
  #
68
81
  # * `STORAGE_OPTIMIZATION` - Once the `FILE_SYSTEM_UPDATE` task to
69
82
  # increase a file system's storage capacity completes successfully,
70
- # a `STORAGE_OPTIMIZATION` task starts. Storage optimization is the
71
- # process of migrating the file system data to the new, larger
72
- # disks. You can track the storage migration progress using the
83
+ # a `STORAGE_OPTIMIZATION` task starts.
84
+ #
85
+ # * For Windows, storage optimization is the process of migrating
86
+ # the file system data to the new, larger disks.
87
+ #
88
+ # * For Lustre, storage optimization consists of rebalancing the
89
+ # data across the existing and newly added file servers.
90
+ #
91
+ # You can track the storage optimization progress using the
73
92
  # `ProgressPercent` property. When `STORAGE_OPTIMIZATION` completes
74
93
  # successfully, the parent `FILE_SYSTEM_UPDATE` action status
75
94
  # changes to `COMPLETED`. For more information, see [Managing
76
- # Storage Capacity][1].
95
+ # storage capacity][1] in the *Amazon FSx for Windows File Server
96
+ # User Guide* and [Managing storage and throughput capacity][2] in
97
+ # the *Amazon FSx for Lustre User Guide*.
98
+ #
99
+ # * `FILE_SYSTEM_ALIAS_ASSOCIATION` - A file system update to
100
+ # associate a new DNS alias with the file system. For more
101
+ # information, see .
102
+ #
103
+ # * `FILE_SYSTEM_ALIAS_DISASSOCIATION` - A file system update to
104
+ # disassociate a DNS alias from the file system. For more
105
+ # information, see .
77
106
  #
78
107
  #
79
108
  #
80
109
  # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
110
+ # [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html
81
111
  # @return [String]
82
112
  #
83
113
  # @!attribute [rw] progress_percent
84
114
  # Provides the percent complete of a `STORAGE_OPTIMIZATION`
85
- # administrative action.
115
+ # administrative action. Does not apply to any other administrative
116
+ # action type.
86
117
  # @return [Integer]
87
118
  #
88
119
  # @!attribute [rw] request_time
@@ -107,16 +138,20 @@ module Aws::FSx
107
138
  # * `UPDATED_OPTIMIZING` - For a storage capacity increase update,
108
139
  # Amazon FSx has updated the file system with the new storage
109
140
  # capacity, and is now performing the storage optimization process.
110
- # For more information, see [Managing Storage Capacity][1].
141
+ # For more information, see [Managing storage capacity][1] in the
142
+ # *Amazon FSx for Windows File Server User Guide* and [Managing
143
+ # storage and throughput capacity][2] in the *Amazon FSx for Lustre
144
+ # User Guide*.
111
145
  #
112
146
  #
113
147
  #
114
148
  # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
149
+ # [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html
115
150
  # @return [String]
116
151
  #
117
152
  # @!attribute [rw] target_file_system_values
118
- # Describes the target `StorageCapacity` or `ThroughputCapacity` value
119
- # provided in the `UpdateFileSystem` operation. Returned for
153
+ # Describes the target value for the administration action, provided
154
+ # in the `UpdateFileSystem` operation. Returned for
120
155
  # `FILE_SYSTEM_UPDATE` administrative actions.
121
156
  # @return [Types::FileSystem]
122
157
  #
@@ -140,7 +175,8 @@ module Aws::FSx
140
175
  # Provides information about a failed administrative action.
141
176
  #
142
177
  # @!attribute [rw] message
143
- # Error message providing details about the failure.
178
+ # Error message providing details about the failed administrative
179
+ # action.
144
180
  # @return [String]
145
181
  #
146
182
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AdministrativeActionFailureDetails AWS API Documentation
@@ -151,7 +187,142 @@ module Aws::FSx
151
187
  include Aws::Structure
152
188
  end
153
189
 
154
- # A backup of an Amazon FSx for file system.
190
+ # A DNS alias that is associated with the file system. You can use a DNS
191
+ # alias to access a file system using user-defined DNS names, in
192
+ # addition to the default DNS name that Amazon FSx assigns to the file
193
+ # system. For more information, see [DNS aliases][1] in the *FSx for
194
+ # Windows File Server User Guide*.
195
+ #
196
+ #
197
+ #
198
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html
199
+ #
200
+ # @!attribute [rw] name
201
+ # The name of the DNS alias. The alias name has to meet the following
202
+ # requirements:
203
+ #
204
+ # * Formatted as a fully-qualified domain name (FQDN),
205
+ # `hostname.domain`, for example, `accounting.example.com`.
206
+ #
207
+ # * Can contain alphanumeric characters, the underscore (\_), and the
208
+ # hyphen (-).
209
+ #
210
+ # * Cannot start or end with a hyphen.
211
+ #
212
+ # * Can start with a numeric.
213
+ #
214
+ # For DNS names, Amazon FSx stores alphabetic characters as lowercase
215
+ # letters (a-z), regardless of how you specify them: as uppercase
216
+ # letters, lowercase letters, or the corresponding letters in escape
217
+ # codes.
218
+ # @return [String]
219
+ #
220
+ # @!attribute [rw] lifecycle
221
+ # Describes the state of the DNS alias.
222
+ #
223
+ # * AVAILABLE - The DNS alias is associated with an Amazon FSx file
224
+ # system.
225
+ #
226
+ # * CREATING - Amazon FSx is creating the DNS alias and associating it
227
+ # with the file system.
228
+ #
229
+ # * CREATE\_FAILED - Amazon FSx was unable to associate the DNS alias
230
+ # with the file system.
231
+ #
232
+ # * DELETING - Amazon FSx is disassociating the DNS alias from the
233
+ # file system and deleting it.
234
+ #
235
+ # * DELETE\_FAILED - Amazon FSx was unable to disassocate the DNS
236
+ # alias from the file system.
237
+ # @return [String]
238
+ #
239
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Alias AWS API Documentation
240
+ #
241
+ class Alias < Struct.new(
242
+ :name,
243
+ :lifecycle)
244
+ SENSITIVE = []
245
+ include Aws::Structure
246
+ end
247
+
248
+ # The request object specifying one or more DNS alias names to associate
249
+ # with an Amazon FSx for Windows File Server file system.
250
+ #
251
+ # @note When making an API call, you may pass AssociateFileSystemAliasesRequest
252
+ # data as a hash:
253
+ #
254
+ # {
255
+ # client_request_token: "ClientRequestToken",
256
+ # file_system_id: "FileSystemId", # required
257
+ # aliases: ["AlternateDNSName"], # required
258
+ # }
259
+ #
260
+ # @!attribute [rw] client_request_token
261
+ # (Optional) An idempotency token for resource creation, in a string
262
+ # of up to 64 ASCII characters. This token is automatically filled on
263
+ # your behalf when you use the AWS Command Line Interface (AWS CLI) or
264
+ # an AWS SDK.
265
+ #
266
+ # **A suitable default value is auto-generated.** You should normally
267
+ # not need to pass this option.
268
+ # @return [String]
269
+ #
270
+ # @!attribute [rw] file_system_id
271
+ # Specifies the file system with which you want to associate one or
272
+ # more DNS aliases.
273
+ # @return [String]
274
+ #
275
+ # @!attribute [rw] aliases
276
+ # An array of one or more DNS alias names to associate with the file
277
+ # system. The alias name has to comply with the following formatting
278
+ # requirements:
279
+ #
280
+ # * Formatted as a fully-qualified domain name (FQDN), <i>
281
+ # <code>hostname.domain</code> </i>, for example,
282
+ # `accounting.corp.example.com`.
283
+ #
284
+ # * Can contain alphanumeric characters and the hyphen (-).
285
+ #
286
+ # * Cannot start or end with a hyphen.
287
+ #
288
+ # * Can start with a numeric.
289
+ #
290
+ # For DNS alias names, Amazon FSx stores alphabetic characters as
291
+ # lowercase letters (a-z), regardless of how you specify them: as
292
+ # uppercase letters, lowercase letters, or the corresponding letters
293
+ # in escape codes.
294
+ # @return [Array<String>]
295
+ #
296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AssociateFileSystemAliasesRequest AWS API Documentation
297
+ #
298
+ class AssociateFileSystemAliasesRequest < Struct.new(
299
+ :client_request_token,
300
+ :file_system_id,
301
+ :aliases)
302
+ SENSITIVE = []
303
+ include Aws::Structure
304
+ end
305
+
306
+ # The system generated response showing the DNS aliases that Amazon FSx
307
+ # is attempting to associate with the file system. Use the API operation
308
+ # to monitor the status of the aliases Amazon FSx is associating with
309
+ # the file system. It can take up to 2.5 minutes for the alias status to
310
+ # change from `CREATING` to `AVAILABLE`.
311
+ #
312
+ # @!attribute [rw] aliases
313
+ # An array of the DNS aliases that Amazon FSx is associating with the
314
+ # file system.
315
+ # @return [Array<Types::Alias>]
316
+ #
317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AssociateFileSystemAliasesResponse AWS API Documentation
318
+ #
319
+ class AssociateFileSystemAliasesResponse < Struct.new(
320
+ :aliases)
321
+ SENSITIVE = []
322
+ include Aws::Structure
323
+ end
324
+
325
+ # A backup of an Amazon FSx file system.
155
326
  #
156
327
  # @!attribute [rw] backup_id
157
328
  # The ID of the backup.
@@ -162,12 +333,18 @@ module Aws::FSx
162
333
  #
163
334
  # * `AVAILABLE` - The backup is fully available.
164
335
  #
165
- # * `CREATING` - FSx is creating the backup.
336
+ # * `PENDING` - For user-initiated backups on Lustre file systems
337
+ # only; Amazon FSx has not started creating the backup.
338
+ #
339
+ # * `CREATING` - Amazon FSx is creating the backup.
166
340
  #
167
- # * `TRANSFERRING` - For Lustre file systems only; FSx is transferring
168
- # the backup to S3.
341
+ # * `TRANSFERRING` - For user-initiated backups on Lustre file systems
342
+ # only; Amazon FSx is transferring the backup to S3.
169
343
  #
170
- # * `DELETED` - The backup was deleted is no longer available.
344
+ # * `COPYING` - Amazon FSx is copying the backup.
345
+ #
346
+ # * `DELETED` - Amazon FSx deleted the backup and it is no longer
347
+ # available.
171
348
  #
172
349
  # * `FAILED` - Amazon FSx could not complete the backup.
173
350
  # @return [String]
@@ -211,6 +388,20 @@ module Aws::FSx
211
388
  # (AD) to which the Windows File Server instance is joined.
212
389
  # @return [Types::ActiveDirectoryBackupAttributes]
213
390
  #
391
+ # @!attribute [rw] owner_id
392
+ # An AWS account ID. This ID is a 12-digit number that you use to
393
+ # construct Amazon Resource Names (ARNs) for resources.
394
+ # @return [String]
395
+ #
396
+ # @!attribute [rw] source_backup_id
397
+ # The ID of the source backup. Specifies the backup you are copying.
398
+ # @return [String]
399
+ #
400
+ # @!attribute [rw] source_backup_region
401
+ # The source Region of the backup. Specifies the Region from where
402
+ # this backup is copied.
403
+ # @return [String]
404
+ #
214
405
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Backup AWS API Documentation
215
406
  #
216
407
  class Backup < Struct.new(
@@ -224,7 +415,29 @@ module Aws::FSx
224
415
  :resource_arn,
225
416
  :tags,
226
417
  :file_system,
227
- :directory_information)
418
+ :directory_information,
419
+ :owner_id,
420
+ :source_backup_id,
421
+ :source_backup_region)
422
+ SENSITIVE = []
423
+ include Aws::Structure
424
+ end
425
+
426
+ # You can't delete a backup while it's being copied.
427
+ #
428
+ # @!attribute [rw] message
429
+ # A detailed error message.
430
+ # @return [String]
431
+ #
432
+ # @!attribute [rw] backup_id
433
+ # The ID of the source backup. Specifies the backup you are copying.
434
+ # @return [String]
435
+ #
436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupBeingCopied AWS API Documentation
437
+ #
438
+ class BackupBeingCopied < Struct.new(
439
+ :message,
440
+ :backup_id)
228
441
  SENSITIVE = []
229
442
  include Aws::Structure
230
443
  end
@@ -423,6 +636,102 @@ module Aws::FSx
423
636
  include Aws::Structure
424
637
  end
425
638
 
639
+ # @note When making an API call, you may pass CopyBackupRequest
640
+ # data as a hash:
641
+ #
642
+ # {
643
+ # client_request_token: "ClientRequestToken",
644
+ # source_backup_id: "SourceBackupId", # required
645
+ # source_region: "Region",
646
+ # kms_key_id: "KmsKeyId",
647
+ # copy_tags: false,
648
+ # tags: [
649
+ # {
650
+ # key: "TagKey", # required
651
+ # value: "TagValue", # required
652
+ # },
653
+ # ],
654
+ # }
655
+ #
656
+ # @!attribute [rw] client_request_token
657
+ # (Optional) An idempotency token for resource creation, in a string
658
+ # of up to 64 ASCII characters. This token is automatically filled on
659
+ # your behalf when you use the AWS Command Line Interface (AWS CLI) or
660
+ # an AWS SDK.
661
+ #
662
+ # **A suitable default value is auto-generated.** You should normally
663
+ # not need to pass this option.
664
+ # @return [String]
665
+ #
666
+ # @!attribute [rw] source_backup_id
667
+ # The ID of the source backup. Specifies the ID of the backup that is
668
+ # being copied.
669
+ # @return [String]
670
+ #
671
+ # @!attribute [rw] source_region
672
+ # The source AWS Region of the backup. Specifies the AWS Region from
673
+ # which the backup is being copied. The source and destination Regions
674
+ # must be in the same AWS partition. If you don't specify a Region,
675
+ # it defaults to the Region where the request is sent from (in-Region
676
+ # copy).
677
+ # @return [String]
678
+ #
679
+ # @!attribute [rw] kms_key_id
680
+ # The ID of the AWS Key Management Service (AWS KMS) key used to
681
+ # encrypt the file system's data for Amazon FSx for Windows File
682
+ # Server file systems and Amazon FSx for Lustre `PERSISTENT_1` file
683
+ # systems at rest. In either case, if not specified, the Amazon FSx
684
+ # managed key is used. The Amazon FSx for Lustre `SCRATCH_1` and
685
+ # `SCRATCH_2` file systems are always encrypted at rest using Amazon
686
+ # FSx managed keys. For more information, see [Encrypt][1] in the *AWS
687
+ # Key Management Service API Reference*.
688
+ #
689
+ #
690
+ #
691
+ # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
692
+ # @return [String]
693
+ #
694
+ # @!attribute [rw] copy_tags
695
+ # A boolean flag indicating whether tags from the source backup should
696
+ # be copied to the backup copy. This value defaults to false.
697
+ #
698
+ # If you set `CopyTags` to true and the source backup has existing
699
+ # tags, you can use the `Tags` parameter to create new tags, provided
700
+ # that the sum of the source backup tags and the new tags doesn't
701
+ # exceed 50. Both sets of tags are merged. If there are tag conflicts
702
+ # (for example, two tags with the same key but different values), the
703
+ # tags created with the `Tags` parameter take precedence.
704
+ # @return [Boolean]
705
+ #
706
+ # @!attribute [rw] tags
707
+ # A list of `Tag` values, with a maximum of 50 elements.
708
+ # @return [Array<Types::Tag>]
709
+ #
710
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopyBackupRequest AWS API Documentation
711
+ #
712
+ class CopyBackupRequest < Struct.new(
713
+ :client_request_token,
714
+ :source_backup_id,
715
+ :source_region,
716
+ :kms_key_id,
717
+ :copy_tags,
718
+ :tags)
719
+ SENSITIVE = []
720
+ include Aws::Structure
721
+ end
722
+
723
+ # @!attribute [rw] backup
724
+ # A backup of an Amazon FSx file system.
725
+ # @return [Types::Backup]
726
+ #
727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopyBackupResponse AWS API Documentation
728
+ #
729
+ class CopyBackupResponse < Struct.new(
730
+ :backup)
731
+ SENSITIVE = []
732
+ include Aws::Structure
733
+ end
734
+
426
735
  # The request object for the `CreateBackup` operation.
427
736
  #
428
737
  # @note When making an API call, you may pass CreateBackupRequest
@@ -609,6 +918,7 @@ module Aws::FSx
609
918
  # daily_automatic_backup_start_time: "DailyTime",
610
919
  # automatic_backup_retention_days: 1,
611
920
  # copy_tags_to_backups: false,
921
+ # aliases: ["AlternateDNSName"],
612
922
  # },
613
923
  # lustre_configuration: {
614
924
  # weekly_maintenance_start_time: "WeeklyTime",
@@ -624,11 +934,11 @@ module Aws::FSx
624
934
  # drive_cache_type: "NONE", # accepts NONE, READ
625
935
  # },
626
936
  # storage_type: "SSD", # accepts SSD, HDD
937
+ # kms_key_id: "KmsKeyId",
627
938
  # }
628
939
  #
629
940
  # @!attribute [rw] backup_id
630
- # The ID of the backup. Specifies the backup to use if you're
631
- # creating a file system from an existing backup.
941
+ # The ID of the source backup. Specifies the backup you are copying.
632
942
  # @return [String]
633
943
  #
634
944
  # @!attribute [rw] client_request_token
@@ -698,6 +1008,21 @@ module Aws::FSx
698
1008
  # </note>
699
1009
  # @return [String]
700
1010
  #
1011
+ # @!attribute [rw] kms_key_id
1012
+ # The ID of the AWS Key Management Service (AWS KMS) key used to
1013
+ # encrypt the file system's data for Amazon FSx for Windows File
1014
+ # Server file systems and Amazon FSx for Lustre `PERSISTENT_1` file
1015
+ # systems at rest. In either case, if not specified, the Amazon FSx
1016
+ # managed key is used. The Amazon FSx for Lustre `SCRATCH_1` and
1017
+ # `SCRATCH_2` file systems are always encrypted at rest using Amazon
1018
+ # FSx managed keys. For more information, see [Encrypt][1] in the *AWS
1019
+ # Key Management Service API Reference*.
1020
+ #
1021
+ #
1022
+ #
1023
+ # [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
1024
+ # @return [String]
1025
+ #
701
1026
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupRequest AWS API Documentation
702
1027
  #
703
1028
  class CreateFileSystemFromBackupRequest < Struct.new(
@@ -708,7 +1033,8 @@ module Aws::FSx
708
1033
  :tags,
709
1034
  :windows_configuration,
710
1035
  :lustre_configuration,
711
- :storage_type)
1036
+ :storage_type,
1037
+ :kms_key_id)
712
1038
  SENSITIVE = []
713
1039
  include Aws::Structure
714
1040
  end
@@ -961,6 +1287,7 @@ module Aws::FSx
961
1287
  # daily_automatic_backup_start_time: "DailyTime",
962
1288
  # automatic_backup_retention_days: 1,
963
1289
  # copy_tags_to_backups: false,
1290
+ # aliases: ["AlternateDNSName"],
964
1291
  # },
965
1292
  # lustre_configuration: {
966
1293
  # weekly_maintenance_start_time: "WeeklyTime",
@@ -1043,11 +1370,17 @@ module Aws::FSx
1043
1370
  # types, provide exactly two subnet IDs, one for the preferred file
1044
1371
  # server and one for the standby file server. You specify one of these
1045
1372
  # subnets as the preferred subnet using the `WindowsConfiguration >
1046
- # PreferredSubnetID` property.
1373
+ # PreferredSubnetID` property. For more information, see [
1374
+ # Availability and durability: Single-AZ and Multi-AZ file
1375
+ # systems][1].
1047
1376
  #
1048
1377
  # For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment
1049
1378
  # types and Lustre file systems, provide exactly one subnet ID. The
1050
1379
  # file server is launched in that subnet's Availability Zone.
1380
+ #
1381
+ #
1382
+ #
1383
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html
1051
1384
  # @return [Array<String>]
1052
1385
  #
1053
1386
  # @!attribute [rw] security_group_ids
@@ -1139,6 +1472,7 @@ module Aws::FSx
1139
1472
  # daily_automatic_backup_start_time: "DailyTime",
1140
1473
  # automatic_backup_retention_days: 1,
1141
1474
  # copy_tags_to_backups: false,
1475
+ # aliases: ["AlternateDNSName"],
1142
1476
  # }
1143
1477
  #
1144
1478
  # @!attribute [rw] active_directory_id
@@ -1149,7 +1483,13 @@ module Aws::FSx
1149
1483
  # @!attribute [rw] self_managed_active_directory_configuration
1150
1484
  # The configuration that Amazon FSx uses to join the Windows File
1151
1485
  # Server instance to your self-managed (including on-premises)
1152
- # Microsoft Active Directory (AD) directory.
1486
+ # Microsoft Active Directory (AD) directory. For more information, see
1487
+ # [ Using Amazon FSx with your self-managed Microsoft Active
1488
+ # Directory][1].
1489
+ #
1490
+ #
1491
+ #
1492
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
1153
1493
  # @return [Types::SelfManagedActiveDirectoryConfiguration]
1154
1494
  #
1155
1495
  # @!attribute [rw] deployment_type
@@ -1221,6 +1561,45 @@ module Aws::FSx
1221
1561
  # system, regardless of this value.
1222
1562
  # @return [Boolean]
1223
1563
  #
1564
+ # @!attribute [rw] aliases
1565
+ # An array of one or more DNS alias names that you want to associate
1566
+ # with the Amazon FSx file system. Aliases allow you to use existing
1567
+ # DNS names to access the data in your Amazon FSx file system. You can
1568
+ # associate up to 50 aliases with a file system at any time. You can
1569
+ # associate additional DNS aliases after you create the file system
1570
+ # using the AssociateFileSystemAliases operation. You can remove DNS
1571
+ # aliases from the file system after it is created using the
1572
+ # DisassociateFileSystemAliases operation. You only need to specify
1573
+ # the alias name in the request payload.
1574
+ #
1575
+ # For more information, see [Working with DNS Aliases][1] and
1576
+ # [Walkthrough 5: Using DNS aliases to access your file system][2],
1577
+ # including additional steps you must take to be able to access your
1578
+ # file system using a DNS alias.
1579
+ #
1580
+ # An alias name has to meet the following requirements:
1581
+ #
1582
+ # * Formatted as a fully-qualified domain name (FQDN),
1583
+ # `hostname.domain`, for example, `accounting.example.com`.
1584
+ #
1585
+ # * Can contain alphanumeric characters, the underscore (\_), and the
1586
+ # hyphen (-).
1587
+ #
1588
+ # * Cannot start or end with a hyphen.
1589
+ #
1590
+ # * Can start with a numeric.
1591
+ #
1592
+ # For DNS alias names, Amazon FSx stores alphabetic characters as
1593
+ # lowercase letters (a-z), regardless of how you specify them: as
1594
+ # uppercase letters, lowercase letters, or the corresponding letters
1595
+ # in escape codes.
1596
+ #
1597
+ #
1598
+ #
1599
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html
1600
+ # [2]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html
1601
+ # @return [Array<String>]
1602
+ #
1224
1603
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemWindowsConfiguration AWS API Documentation
1225
1604
  #
1226
1605
  class CreateFileSystemWindowsConfiguration < Struct.new(
@@ -1232,7 +1611,8 @@ module Aws::FSx
1232
1611
  :weekly_maintenance_start_time,
1233
1612
  :daily_automatic_backup_start_time,
1234
1613
  :automatic_backup_retention_days,
1235
- :copy_tags_to_backups)
1614
+ :copy_tags_to_backups,
1615
+ :aliases)
1236
1616
  SENSITIVE = []
1237
1617
  include Aws::Structure
1238
1618
  end
@@ -1930,7 +2310,7 @@ module Aws::FSx
1930
2310
  # Response object for `DescribeBackups` operation.
1931
2311
  #
1932
2312
  # @!attribute [rw] backups
1933
- # Any array of backups.
2313
+ # An array of backups.
1934
2314
  # @return [Array<Types::Backup>]
1935
2315
  #
1936
2316
  # @!attribute [rw] next_token
@@ -2017,6 +2397,81 @@ module Aws::FSx
2017
2397
  include Aws::Structure
2018
2398
  end
2019
2399
 
2400
+ # The request object for `DescribeFileSystemAliases` operation.
2401
+ #
2402
+ # @note When making an API call, you may pass DescribeFileSystemAliasesRequest
2403
+ # data as a hash:
2404
+ #
2405
+ # {
2406
+ # client_request_token: "ClientRequestToken",
2407
+ # file_system_id: "FileSystemId", # required
2408
+ # max_results: 1,
2409
+ # next_token: "NextToken",
2410
+ # }
2411
+ #
2412
+ # @!attribute [rw] client_request_token
2413
+ # (Optional) An idempotency token for resource creation, in a string
2414
+ # of up to 64 ASCII characters. This token is automatically filled on
2415
+ # your behalf when you use the AWS Command Line Interface (AWS CLI) or
2416
+ # an AWS SDK.
2417
+ #
2418
+ # **A suitable default value is auto-generated.** You should normally
2419
+ # not need to pass this option.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] file_system_id
2423
+ # The ID of the file system to return the associated DNS aliases for
2424
+ # (String).
2425
+ # @return [String]
2426
+ #
2427
+ # @!attribute [rw] max_results
2428
+ # Maximum number of DNS aliases to return in the response (integer).
2429
+ # This parameter value must be greater than 0. The number of items
2430
+ # that Amazon FSx returns is the minimum of the `MaxResults` parameter
2431
+ # specified in the request and the service's internal maximum number
2432
+ # of items per page.
2433
+ # @return [Integer]
2434
+ #
2435
+ # @!attribute [rw] next_token
2436
+ # Opaque pagination token returned from a previous
2437
+ # `DescribeFileSystemAliases` operation (String). If a token is
2438
+ # included in the request, the action continues the list from where
2439
+ # the previous returning call left off.
2440
+ # @return [String]
2441
+ #
2442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemAliasesRequest AWS API Documentation
2443
+ #
2444
+ class DescribeFileSystemAliasesRequest < Struct.new(
2445
+ :client_request_token,
2446
+ :file_system_id,
2447
+ :max_results,
2448
+ :next_token)
2449
+ SENSITIVE = []
2450
+ include Aws::Structure
2451
+ end
2452
+
2453
+ # The response object for `DescribeFileSystemAliases` operation.
2454
+ #
2455
+ # @!attribute [rw] aliases
2456
+ # An array of one or more DNS aliases currently associated with the
2457
+ # specified file system.
2458
+ # @return [Array<Types::Alias>]
2459
+ #
2460
+ # @!attribute [rw] next_token
2461
+ # Present if there are more DNS aliases than returned in the response
2462
+ # (String). You can use the `NextToken` value in a later request to
2463
+ # fetch additional descriptions.
2464
+ # @return [String]
2465
+ #
2466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemAliasesResponse AWS API Documentation
2467
+ #
2468
+ class DescribeFileSystemAliasesResponse < Struct.new(
2469
+ :aliases,
2470
+ :next_token)
2471
+ SENSITIVE = []
2472
+ include Aws::Structure
2473
+ end
2474
+
2020
2475
  # The request object for `DescribeFileSystems` operation.
2021
2476
  #
2022
2477
  # @note When making an API call, you may pass DescribeFileSystemsRequest
@@ -2078,6 +2533,66 @@ module Aws::FSx
2078
2533
  include Aws::Structure
2079
2534
  end
2080
2535
 
2536
+ # The request object of DNS aliases to disassociate from an Amazon FSx
2537
+ # for Windows File Server file system.
2538
+ #
2539
+ # @note When making an API call, you may pass DisassociateFileSystemAliasesRequest
2540
+ # data as a hash:
2541
+ #
2542
+ # {
2543
+ # client_request_token: "ClientRequestToken",
2544
+ # file_system_id: "FileSystemId", # required
2545
+ # aliases: ["AlternateDNSName"], # required
2546
+ # }
2547
+ #
2548
+ # @!attribute [rw] client_request_token
2549
+ # (Optional) An idempotency token for resource creation, in a string
2550
+ # of up to 64 ASCII characters. This token is automatically filled on
2551
+ # your behalf when you use the AWS Command Line Interface (AWS CLI) or
2552
+ # an AWS SDK.
2553
+ #
2554
+ # **A suitable default value is auto-generated.** You should normally
2555
+ # not need to pass this option.
2556
+ # @return [String]
2557
+ #
2558
+ # @!attribute [rw] file_system_id
2559
+ # Specifies the file system from which to disassociate the DNS
2560
+ # aliases.
2561
+ # @return [String]
2562
+ #
2563
+ # @!attribute [rw] aliases
2564
+ # An array of one or more DNS alias names to disassociate, or remove,
2565
+ # from the file system.
2566
+ # @return [Array<String>]
2567
+ #
2568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DisassociateFileSystemAliasesRequest AWS API Documentation
2569
+ #
2570
+ class DisassociateFileSystemAliasesRequest < Struct.new(
2571
+ :client_request_token,
2572
+ :file_system_id,
2573
+ :aliases)
2574
+ SENSITIVE = []
2575
+ include Aws::Structure
2576
+ end
2577
+
2578
+ # The system generated response showing the DNS aliases that Amazon FSx
2579
+ # is attempting to disassociate from the file system. Use the API
2580
+ # operation to monitor the status of the aliases Amazon FSx is removing
2581
+ # from the file system.
2582
+ #
2583
+ # @!attribute [rw] aliases
2584
+ # An array of one or more DNS aliases that Amazon FSx is attempting to
2585
+ # disassociate from the file system.
2586
+ # @return [Array<Types::Alias>]
2587
+ #
2588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DisassociateFileSystemAliasesResponse AWS API Documentation
2589
+ #
2590
+ class DisassociateFileSystemAliasesResponse < Struct.new(
2591
+ :aliases)
2592
+ SENSITIVE = []
2593
+ include Aws::Structure
2594
+ end
2595
+
2081
2596
  # A description of a specific Amazon FSx file system.
2082
2597
  #
2083
2598
  # @!attribute [rw] owner_id
@@ -2127,7 +2642,7 @@ module Aws::FSx
2127
2642
  # @return [Types::FileSystemFailureDetails]
2128
2643
  #
2129
2644
  # @!attribute [rw] storage_capacity
2130
- # The storage capacity of the file system in gigabytes (GB).
2645
+ # The storage capacity of the file system in gibibytes (GiB).
2131
2646
  # @return [Integer]
2132
2647
  #
2133
2648
  # @!attribute [rw] storage_type
@@ -2325,6 +2840,21 @@ module Aws::FSx
2325
2840
  include Aws::Structure
2326
2841
  end
2327
2842
 
2843
+ # Amazon FSx doesn't support Multi-AZ Windows File Server copy backup
2844
+ # in the destination Region, so the copied backup can't be restored.
2845
+ #
2846
+ # @!attribute [rw] message
2847
+ # A detailed error message.
2848
+ # @return [String]
2849
+ #
2850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/IncompatibleRegionForMultiAZ AWS API Documentation
2851
+ #
2852
+ class IncompatibleRegionForMultiAZ < Struct.new(
2853
+ :message)
2854
+ SENSITIVE = []
2855
+ include Aws::Structure
2856
+ end
2857
+
2328
2858
  # A generic error indicating a server-side failure.
2329
2859
  #
2330
2860
  # @!attribute [rw] message
@@ -2339,6 +2869,21 @@ module Aws::FSx
2339
2869
  include Aws::Structure
2340
2870
  end
2341
2871
 
2872
+ # The AWS Key Management Service (AWS KMS) key of the destination backup
2873
+ # is invalid.
2874
+ #
2875
+ # @!attribute [rw] message
2876
+ # A detailed error message.
2877
+ # @return [String]
2878
+ #
2879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidDestinationKmsKey AWS API Documentation
2880
+ #
2881
+ class InvalidDestinationKmsKey < Struct.new(
2882
+ :message)
2883
+ SENSITIVE = []
2884
+ include Aws::Structure
2885
+ end
2886
+
2342
2887
  # The path provided for data repository export isn't valid.
2343
2888
  #
2344
2889
  # @!attribute [rw] message
@@ -2425,6 +2970,36 @@ module Aws::FSx
2425
2970
  include Aws::Structure
2426
2971
  end
2427
2972
 
2973
+ # The Region provided for `Source Region` is invalid or is in a
2974
+ # different AWS partition.
2975
+ #
2976
+ # @!attribute [rw] message
2977
+ # A detailed error message.
2978
+ # @return [String]
2979
+ #
2980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidRegion AWS API Documentation
2981
+ #
2982
+ class InvalidRegion < Struct.new(
2983
+ :message)
2984
+ SENSITIVE = []
2985
+ include Aws::Structure
2986
+ end
2987
+
2988
+ # The AWS Key Management Service (AWS KMS) key of the source backup is
2989
+ # invalid.
2990
+ #
2991
+ # @!attribute [rw] message
2992
+ # A detailed error message.
2993
+ # @return [String]
2994
+ #
2995
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/InvalidSourceKmsKey AWS API Documentation
2996
+ #
2997
+ class InvalidSourceKmsKey < Struct.new(
2998
+ :message)
2999
+ SENSITIVE = []
3000
+ include Aws::Structure
3001
+ end
3002
+
2428
3003
  # The request object for `ListTagsForResource` operation.
2429
3004
  #
2430
3005
  # @note When making an API call, you may pass ListTagsForResourceRequest
@@ -2703,7 +3278,12 @@ module Aws::FSx
2703
3278
 
2704
3279
  # The configuration that Amazon FSx uses to join the Windows File Server
2705
3280
  # instance to your self-managed (including on-premises) Microsoft Active
2706
- # Directory (AD) directory.
3281
+ # Directory (AD) directory. For more information, see [ Using Amazon FSx
3282
+ # with your self-managed Microsoft Active Directory][1].
3283
+ #
3284
+ #
3285
+ #
3286
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/self-managed-AD.html
2707
3287
  #
2708
3288
  # @note When making an API call, you may pass SelfManagedActiveDirectoryConfiguration
2709
3289
  # data as a hash:
@@ -2765,20 +3345,7 @@ module Aws::FSx
2765
3345
  #
2766
3346
  # @!attribute [rw] dns_ips
2767
3347
  # A list of up to two IP addresses of DNS servers or domain
2768
- # controllers in the self-managed AD directory. The IP addresses need
2769
- # to be either in the same VPC CIDR range as the one in which your
2770
- # Amazon FSx file system is being created, or in the private IP
2771
- # version 4 (IPv4) address ranges, as specified in [RFC 1918][1]\:
2772
- #
2773
- # * 10\.0.0.0 - 10.255.255.255 (10/8 prefix)
2774
- #
2775
- # * 172\.16.0.0 - 172.31.255.255 (172.16/12 prefix)
2776
- #
2777
- # * 192\.168.0.0 - 192.168.255.255 (192.168/16 prefix)
2778
- #
2779
- #
2780
- #
2781
- # [1]: http://www.faqs.org/rfcs/rfc1918.html
3348
+ # controllers in the self-managed AD directory.
2782
3349
  # @return [Array<String>]
2783
3350
  #
2784
3351
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SelfManagedActiveDirectoryConfiguration AWS API Documentation
@@ -2854,6 +3421,26 @@ module Aws::FSx
2854
3421
  include Aws::Structure
2855
3422
  end
2856
3423
 
3424
+ # The request was rejected because the lifecycle status of the source
3425
+ # backup is not `AVAILABLE`.
3426
+ #
3427
+ # @!attribute [rw] message
3428
+ # A detailed error message.
3429
+ # @return [String]
3430
+ #
3431
+ # @!attribute [rw] backup_id
3432
+ # The ID of the source backup. Specifies the backup you are copying.
3433
+ # @return [String]
3434
+ #
3435
+ # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SourceBackupUnavailable AWS API Documentation
3436
+ #
3437
+ class SourceBackupUnavailable < Struct.new(
3438
+ :message,
3439
+ :backup_id)
3440
+ SENSITIVE = []
3441
+ include Aws::Structure
3442
+ end
3443
+
2857
3444
  # Specifies a key-value pair for a resource tag.
2858
3445
  #
2859
3446
  # @note When making an API call, you may pass Tag
@@ -3089,18 +3676,40 @@ module Aws::FSx
3089
3676
  #
3090
3677
  # @!attribute [rw] storage_capacity
3091
3678
  # Use this parameter to increase the storage capacity of an Amazon FSx
3092
- # for Windows File Server file system. Specifies the storage capacity
3093
- # target value, GiB, for the file system you're updating. The storage
3094
- # capacity target value must be at least 10 percent (%) greater than
3095
- # the current storage capacity value. In order to increase storage
3096
- # capacity, the file system needs to have at least 16 MB/s of
3097
- # throughput capacity. You cannot make a storage capacity increase
3098
- # request if there is an existing storage capacity increase request in
3099
- # progress. For more information, see [Managing Storage Capacity][1].
3679
+ # file system. Specifies the storage capacity target value, GiB, to
3680
+ # increase the storage capacity for the file system that you're
3681
+ # updating. You cannot make a storage capacity increase request if
3682
+ # there is an existing storage capacity increase request in progress.
3683
+ #
3684
+ # For Windows file systems, the storage capacity target value must be
3685
+ # at least 10 percent (%) greater than the current storage capacity
3686
+ # value. In order to increase storage capacity, the file system must
3687
+ # have at least 16 MB/s of throughput capacity.
3688
+ #
3689
+ # For Lustre file systems, the storage capacity target value can be
3690
+ # the following:
3691
+ #
3692
+ # * For `SCRATCH_2` and `PERSISTENT_1 SSD` deployment types, valid
3693
+ # values are in multiples of 2400 GiB. The value must be greater
3694
+ # than the current storage capacity.
3695
+ #
3696
+ # * For `PERSISTENT HDD` file systems, valid values are multiples of
3697
+ # 6000 GiB for 12 MB/s/TiB file systems and multiples of 1800 GiB
3698
+ # for 40 MB/s/TiB file systems. The values must be greater than the
3699
+ # current storage capacity.
3700
+ #
3701
+ # * For `SCRATCH_1` file systems, you cannot increase the storage
3702
+ # capacity.
3703
+ #
3704
+ # For more information, see [Managing storage capacity][1] in the
3705
+ # *Amazon FSx for Windows File Server User Guide* and [Managing
3706
+ # storage and throughput capacity][2] in the *Amazon FSx for Lustre
3707
+ # User Guide*.
3100
3708
  #
3101
3709
  #
3102
3710
  #
3103
3711
  # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
3712
+ # [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html
3104
3713
  # @return [Integer]
3105
3714
  #
3106
3715
  # @!attribute [rw] windows_configuration
@@ -3215,8 +3824,8 @@ module Aws::FSx
3215
3824
  # The configuration for this Microsoft Windows file system.
3216
3825
  #
3217
3826
  # @!attribute [rw] active_directory_id
3218
- # The ID for an existing Microsoft Active Directory instance that the
3219
- # file system should join when it's created.
3827
+ # The ID for an existing AWS Managed Microsoft Active Directory
3828
+ # instance that the file system is joined to.
3220
3829
  # @return [String]
3221
3830
  #
3222
3831
  # @!attribute [rw] self_managed_active_directory_configuration
@@ -3268,8 +3877,8 @@ module Aws::FSx
3268
3877
  #
3269
3878
  # For `SINGLE_AZ_1` and `SINGLE_AZ_2` deployment types, this value is
3270
3879
  # the same as that for `SubnetIDs`. For more information, see
3271
- # [Availability and Durability: Single-AZ and Multi-AZ File
3272
- # Systems][1]
3880
+ # [Availability and durability: Single-AZ and Multi-AZ file
3881
+ # systems][1].
3273
3882
  #
3274
3883
  #
3275
3884
  #
@@ -3295,7 +3904,7 @@ module Aws::FSx
3295
3904
  # @return [String]
3296
3905
  #
3297
3906
  # @!attribute [rw] throughput_capacity
3298
- # The throughput of an Amazon FSx file system, measured in megabytes
3907
+ # The throughput of the Amazon FSx file system, measured in megabytes
3299
3908
  # per second.
3300
3909
  # @return [Integer]
3301
3910
  #
@@ -3331,6 +3940,23 @@ module Aws::FSx
3331
3940
  # copied from the file system, regardless of this value.
3332
3941
  # @return [Boolean]
3333
3942
  #
3943
+ # @!attribute [rw] aliases
3944
+ # An array of one or more DNS aliases that are currently associated
3945
+ # with the Amazon FSx file system. Aliases allow you to use existing
3946
+ # DNS names to access the data in your Amazon FSx file system. You can
3947
+ # associate up to 50 aliases with a file system at any time. You can
3948
+ # associate additional DNS aliases after you create the file system
3949
+ # using the AssociateFileSystemAliases operation. You can remove DNS
3950
+ # aliases from the file system after it is created using the
3951
+ # DisassociateFileSystemAliases operation. You only need to specify
3952
+ # the alias name in the request payload. For more information, see
3953
+ # [DNS aliases][1].
3954
+ #
3955
+ #
3956
+ #
3957
+ # [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html
3958
+ # @return [Array<Types::Alias>]
3959
+ #
3334
3960
  # @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsFileSystemConfiguration AWS API Documentation
3335
3961
  #
3336
3962
  class WindowsFileSystemConfiguration < Struct.new(
@@ -3345,7 +3971,8 @@ module Aws::FSx
3345
3971
  :weekly_maintenance_start_time,
3346
3972
  :daily_automatic_backup_start_time,
3347
3973
  :automatic_backup_retention_days,
3348
- :copy_tags_to_backups)
3974
+ :copy_tags_to_backups,
3975
+ :aliases)
3349
3976
  SENSITIVE = []
3350
3977
  include Aws::Structure
3351
3978
  end