aws-sdk-fsx 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-fsx.rb +47 -0
- data/lib/aws-sdk-fsx/client.rb +1592 -0
- data/lib/aws-sdk-fsx/client_api.rb +510 -0
- data/lib/aws-sdk-fsx/customizations.rb +0 -0
- data/lib/aws-sdk-fsx/errors.rb +14 -0
- data/lib/aws-sdk-fsx/resource.rb +23 -0
- data/lib/aws-sdk-fsx/types.rb +1331 -0
- metadata +88 -0
File without changes
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::FSx
|
9
|
+
module Errors
|
10
|
+
|
11
|
+
extend Aws::Errors::DynamicErrors
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::FSx
|
9
|
+
class Resource
|
10
|
+
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
16
|
+
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
20
|
+
end
|
21
|
+
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,1331 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws::FSx
|
9
|
+
module Types
|
10
|
+
|
11
|
+
# A backup of an Amazon FSx for Windows File Server file system. You can
|
12
|
+
# create a new file system from a backup to protect against data loss.
|
13
|
+
#
|
14
|
+
# @!attribute [rw] backup_id
|
15
|
+
# The ID of the backup.
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @!attribute [rw] lifecycle
|
19
|
+
# The lifecycle status of the backup.
|
20
|
+
# @return [String]
|
21
|
+
#
|
22
|
+
# @!attribute [rw] failure_details
|
23
|
+
# Details explaining any failures that occur when creating a backup.
|
24
|
+
# @return [Types::BackupFailureDetails]
|
25
|
+
#
|
26
|
+
# @!attribute [rw] type
|
27
|
+
# The type of the backup.
|
28
|
+
# @return [String]
|
29
|
+
#
|
30
|
+
# @!attribute [rw] progress_percent
|
31
|
+
# The current percent of progress of an asynchronous task.
|
32
|
+
# @return [Integer]
|
33
|
+
#
|
34
|
+
# @!attribute [rw] creation_time
|
35
|
+
# The time when a particular backup was created.
|
36
|
+
# @return [Time]
|
37
|
+
#
|
38
|
+
# @!attribute [rw] kms_key_id
|
39
|
+
# The ID of the AWS Key Management Service (AWS KMS) key used to
|
40
|
+
# encrypt this backup's data.
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] resource_arn
|
44
|
+
# The Amazon Resource Name (ARN) for the backup resource.
|
45
|
+
# @return [String]
|
46
|
+
#
|
47
|
+
# @!attribute [rw] tags
|
48
|
+
# Tags associated with a particular file system.
|
49
|
+
# @return [Array<Types::Tag>]
|
50
|
+
#
|
51
|
+
# @!attribute [rw] file_system
|
52
|
+
# Metadata of the file system associated with the backup. This
|
53
|
+
# metadata is persisted even if the file system is deleted.
|
54
|
+
# @return [Types::FileSystem]
|
55
|
+
#
|
56
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Backup AWS API Documentation
|
57
|
+
#
|
58
|
+
class Backup < Struct.new(
|
59
|
+
:backup_id,
|
60
|
+
:lifecycle,
|
61
|
+
:failure_details,
|
62
|
+
:type,
|
63
|
+
:progress_percent,
|
64
|
+
:creation_time,
|
65
|
+
:kms_key_id,
|
66
|
+
:resource_arn,
|
67
|
+
:tags,
|
68
|
+
:file_system)
|
69
|
+
include Aws::Structure
|
70
|
+
end
|
71
|
+
|
72
|
+
# If backup creation fails, this structure contains the details of that
|
73
|
+
# failure.
|
74
|
+
#
|
75
|
+
# @!attribute [rw] message
|
76
|
+
# A message describing the backup creation failure.
|
77
|
+
# @return [String]
|
78
|
+
#
|
79
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/BackupFailureDetails AWS API Documentation
|
80
|
+
#
|
81
|
+
class BackupFailureDetails < Struct.new(
|
82
|
+
:message)
|
83
|
+
include Aws::Structure
|
84
|
+
end
|
85
|
+
|
86
|
+
# The request object for the `CreateBackup` operation.
|
87
|
+
#
|
88
|
+
# @note When making an API call, you may pass CreateBackupRequest
|
89
|
+
# data as a hash:
|
90
|
+
#
|
91
|
+
# {
|
92
|
+
# file_system_id: "FileSystemId", # required
|
93
|
+
# client_request_token: "ClientRequestToken",
|
94
|
+
# tags: [
|
95
|
+
# {
|
96
|
+
# key: "TagKey",
|
97
|
+
# value: "TagValue",
|
98
|
+
# },
|
99
|
+
# ],
|
100
|
+
# }
|
101
|
+
#
|
102
|
+
# @!attribute [rw] file_system_id
|
103
|
+
# The ID of the file system to back up.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @!attribute [rw] client_request_token
|
107
|
+
# (Optional) A string of up to 64 ASCII characters that Amazon FSx
|
108
|
+
# uses to ensure idempotent creation. This string is automatically
|
109
|
+
# filled on your behalf when you use the AWS Command Line Interface
|
110
|
+
# (AWS CLI) or an AWS SDK.
|
111
|
+
#
|
112
|
+
# **A suitable default value is auto-generated.** You should normally
|
113
|
+
# not need to pass this option.
|
114
|
+
# @return [String]
|
115
|
+
#
|
116
|
+
# @!attribute [rw] tags
|
117
|
+
# The tags to apply to the backup at backup creation. The key value of
|
118
|
+
# the `Name` tag appears in the console as the backup name.
|
119
|
+
# @return [Array<Types::Tag>]
|
120
|
+
#
|
121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupRequest AWS API Documentation
|
122
|
+
#
|
123
|
+
class CreateBackupRequest < Struct.new(
|
124
|
+
:file_system_id,
|
125
|
+
:client_request_token,
|
126
|
+
:tags)
|
127
|
+
include Aws::Structure
|
128
|
+
end
|
129
|
+
|
130
|
+
# The response object for the `CreateBackup` operation.
|
131
|
+
#
|
132
|
+
# @!attribute [rw] backup
|
133
|
+
# A description of the backup.
|
134
|
+
# @return [Types::Backup]
|
135
|
+
#
|
136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupResponse AWS API Documentation
|
137
|
+
#
|
138
|
+
class CreateBackupResponse < Struct.new(
|
139
|
+
:backup)
|
140
|
+
include Aws::Structure
|
141
|
+
end
|
142
|
+
|
143
|
+
# The request object for the `CreateFileSystemFromBackup` operation.
|
144
|
+
#
|
145
|
+
# @note When making an API call, you may pass CreateFileSystemFromBackupRequest
|
146
|
+
# data as a hash:
|
147
|
+
#
|
148
|
+
# {
|
149
|
+
# backup_id: "BackupId", # required
|
150
|
+
# client_request_token: "ClientRequestToken",
|
151
|
+
# subnet_ids: ["SubnetId"], # required
|
152
|
+
# security_group_ids: ["SecurityGroupId"],
|
153
|
+
# tags: [
|
154
|
+
# {
|
155
|
+
# key: "TagKey",
|
156
|
+
# value: "TagValue",
|
157
|
+
# },
|
158
|
+
# ],
|
159
|
+
# windows_configuration: {
|
160
|
+
# active_directory_id: "DirectoryId",
|
161
|
+
# throughput_capacity: 1, # required
|
162
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
163
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
164
|
+
# automatic_backup_retention_days: 1,
|
165
|
+
# copy_tags_to_backups: false,
|
166
|
+
# },
|
167
|
+
# }
|
168
|
+
#
|
169
|
+
# @!attribute [rw] backup_id
|
170
|
+
# The ID of the backup.
|
171
|
+
# @return [String]
|
172
|
+
#
|
173
|
+
# @!attribute [rw] client_request_token
|
174
|
+
# (Optional) A string of up to 64 ASCII characters that Amazon FSx
|
175
|
+
# uses to ensure idempotent creation. This string is automatically
|
176
|
+
# filled on your behalf when you use the AWS Command Line Interface
|
177
|
+
# (AWS CLI) or an AWS SDK.
|
178
|
+
#
|
179
|
+
# **A suitable default value is auto-generated.** You should normally
|
180
|
+
# not need to pass this option.
|
181
|
+
# @return [String]
|
182
|
+
#
|
183
|
+
# @!attribute [rw] subnet_ids
|
184
|
+
# A list of IDs for the subnets that the file system will be
|
185
|
+
# accessible from. Currently, you can specify only one subnet. The
|
186
|
+
# file server is also launched in that subnet's Availability Zone.
|
187
|
+
# @return [Array<String>]
|
188
|
+
#
|
189
|
+
# @!attribute [rw] security_group_ids
|
190
|
+
# A list of IDs for the security groups that apply to the specified
|
191
|
+
# network interfaces created for file system access. These security
|
192
|
+
# groups apply to all network interfaces. This value isn't returned
|
193
|
+
# in later describe requests.
|
194
|
+
# @return [Array<String>]
|
195
|
+
#
|
196
|
+
# @!attribute [rw] tags
|
197
|
+
# The tags to be applied to the file system at file system creation.
|
198
|
+
# The key value of the `Name` tag appears in the console as the file
|
199
|
+
# system name.
|
200
|
+
# @return [Array<Types::Tag>]
|
201
|
+
#
|
202
|
+
# @!attribute [rw] windows_configuration
|
203
|
+
# The configuration for this Microsoft Windows file system.
|
204
|
+
# @return [Types::CreateFileSystemWindowsConfiguration]
|
205
|
+
#
|
206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupRequest AWS API Documentation
|
207
|
+
#
|
208
|
+
class CreateFileSystemFromBackupRequest < Struct.new(
|
209
|
+
:backup_id,
|
210
|
+
:client_request_token,
|
211
|
+
:subnet_ids,
|
212
|
+
:security_group_ids,
|
213
|
+
:tags,
|
214
|
+
:windows_configuration)
|
215
|
+
include Aws::Structure
|
216
|
+
end
|
217
|
+
|
218
|
+
# The response object for the `CreateFileSystemFromBackup` operation.
|
219
|
+
#
|
220
|
+
# @!attribute [rw] file_system
|
221
|
+
# A description of the file system.
|
222
|
+
# @return [Types::FileSystem]
|
223
|
+
#
|
224
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackupResponse AWS API Documentation
|
225
|
+
#
|
226
|
+
class CreateFileSystemFromBackupResponse < Struct.new(
|
227
|
+
:file_system)
|
228
|
+
include Aws::Structure
|
229
|
+
end
|
230
|
+
|
231
|
+
# The configuration object for Lustre file systems used in the
|
232
|
+
# `CreateFileSystem` operation.
|
233
|
+
#
|
234
|
+
# @note When making an API call, you may pass CreateFileSystemLustreConfiguration
|
235
|
+
# data as a hash:
|
236
|
+
#
|
237
|
+
# {
|
238
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
239
|
+
# import_path: "ArchivePath",
|
240
|
+
# imported_file_chunk_size: 1,
|
241
|
+
# }
|
242
|
+
#
|
243
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
244
|
+
# The preferred time to perform weekly maintenance, in the UTC time
|
245
|
+
# zone.
|
246
|
+
# @return [String]
|
247
|
+
#
|
248
|
+
# @!attribute [rw] import_path
|
249
|
+
# (Optional) The path to the Amazon S3 bucket (and optional prefix)
|
250
|
+
# that you're using as the data repository for your FSx for Lustre
|
251
|
+
# file system, for example `s3://import-bucket/optional-prefix`. If
|
252
|
+
# you specify a prefix after the Amazon S3 bucket name, only object
|
253
|
+
# keys with that prefix are loaded into the file system.
|
254
|
+
# @return [String]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] imported_file_chunk_size
|
257
|
+
# (Optional) For files imported from a data repository, this value
|
258
|
+
# determines the stripe count and maximum amount of data per file (in
|
259
|
+
# MiB) stored on a single physical disk. The maximum number of disks
|
260
|
+
# that a single file can be striped across is limited by the total
|
261
|
+
# number of disks that make up the file system.
|
262
|
+
#
|
263
|
+
# The chunk size default is 1,024 MiB (1 GiB) and can go as high as
|
264
|
+
# 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5
|
265
|
+
# TB.
|
266
|
+
# @return [Integer]
|
267
|
+
#
|
268
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemLustreConfiguration AWS API Documentation
|
269
|
+
#
|
270
|
+
class CreateFileSystemLustreConfiguration < Struct.new(
|
271
|
+
:weekly_maintenance_start_time,
|
272
|
+
:import_path,
|
273
|
+
:imported_file_chunk_size)
|
274
|
+
include Aws::Structure
|
275
|
+
end
|
276
|
+
|
277
|
+
# The request object for the `CreateFileSystem` operation.
|
278
|
+
#
|
279
|
+
# @note When making an API call, you may pass CreateFileSystemRequest
|
280
|
+
# data as a hash:
|
281
|
+
#
|
282
|
+
# {
|
283
|
+
# client_request_token: "ClientRequestToken",
|
284
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE
|
285
|
+
# storage_capacity: 1, # required
|
286
|
+
# subnet_ids: ["SubnetId"], # required
|
287
|
+
# security_group_ids: ["SecurityGroupId"],
|
288
|
+
# tags: [
|
289
|
+
# {
|
290
|
+
# key: "TagKey",
|
291
|
+
# value: "TagValue",
|
292
|
+
# },
|
293
|
+
# ],
|
294
|
+
# kms_key_id: "KmsKeyId",
|
295
|
+
# windows_configuration: {
|
296
|
+
# active_directory_id: "DirectoryId",
|
297
|
+
# throughput_capacity: 1, # required
|
298
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
299
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
300
|
+
# automatic_backup_retention_days: 1,
|
301
|
+
# copy_tags_to_backups: false,
|
302
|
+
# },
|
303
|
+
# lustre_configuration: {
|
304
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
305
|
+
# import_path: "ArchivePath",
|
306
|
+
# imported_file_chunk_size: 1,
|
307
|
+
# },
|
308
|
+
# }
|
309
|
+
#
|
310
|
+
# @!attribute [rw] client_request_token
|
311
|
+
# (Optional) A string of up to 64 ASCII characters that Amazon FSx
|
312
|
+
# uses to ensure idempotent creation. This string is automatically
|
313
|
+
# filled on your behalf when you use the AWS Command Line Interface
|
314
|
+
# (AWS CLI) or an AWS SDK.
|
315
|
+
#
|
316
|
+
# **A suitable default value is auto-generated.** You should normally
|
317
|
+
# not need to pass this option.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] file_system_type
|
321
|
+
# The type of file system.
|
322
|
+
# @return [String]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] storage_capacity
|
325
|
+
# The storage capacity of the file system.
|
326
|
+
#
|
327
|
+
# For Windows file systems, the storage capacity has a minimum of 300
|
328
|
+
# GiB, and a maximum of 65,536 GiB.
|
329
|
+
#
|
330
|
+
# For Lustre file systems, the storage capacity has a minimum of 3,600
|
331
|
+
# GiB. Storage capacity is provisioned in increments of 3,600 GiB.
|
332
|
+
# @return [Integer]
|
333
|
+
#
|
334
|
+
# @!attribute [rw] subnet_ids
|
335
|
+
# A list of IDs for the subnets that the file system will be
|
336
|
+
# accessible from. File systems support only one subnet. The file
|
337
|
+
# server is also launched in that subnet's Availability Zone.
|
338
|
+
# @return [Array<String>]
|
339
|
+
#
|
340
|
+
# @!attribute [rw] security_group_ids
|
341
|
+
# A list of IDs for the security groups that apply to the specified
|
342
|
+
# network interfaces created for file system access. These security
|
343
|
+
# groups will apply to all network interfaces. This list isn't
|
344
|
+
# returned in later describe requests.
|
345
|
+
# @return [Array<String>]
|
346
|
+
#
|
347
|
+
# @!attribute [rw] tags
|
348
|
+
# The tags to be applied to the file system at file system creation.
|
349
|
+
# The key value of the `Name` tag appears in the console as the file
|
350
|
+
# system name.
|
351
|
+
# @return [Array<Types::Tag>]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] kms_key_id
|
354
|
+
# The ID of your AWS Key Management Service (AWS KMS) key. This ID is
|
355
|
+
# used to encrypt the data in your file system at rest. For more
|
356
|
+
# information, see [Encrypt][1] in the *AWS Key Management Service API
|
357
|
+
# Reference*.
|
358
|
+
#
|
359
|
+
#
|
360
|
+
#
|
361
|
+
# [1]: http://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
|
362
|
+
# @return [String]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] windows_configuration
|
365
|
+
# The configuration for this Microsoft Windows file system.
|
366
|
+
# @return [Types::CreateFileSystemWindowsConfiguration]
|
367
|
+
#
|
368
|
+
# @!attribute [rw] lustre_configuration
|
369
|
+
# The configuration object for Lustre file systems used in the
|
370
|
+
# `CreateFileSystem` operation.
|
371
|
+
# @return [Types::CreateFileSystemLustreConfiguration]
|
372
|
+
#
|
373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemRequest AWS API Documentation
|
374
|
+
#
|
375
|
+
class CreateFileSystemRequest < Struct.new(
|
376
|
+
:client_request_token,
|
377
|
+
:file_system_type,
|
378
|
+
:storage_capacity,
|
379
|
+
:subnet_ids,
|
380
|
+
:security_group_ids,
|
381
|
+
:tags,
|
382
|
+
:kms_key_id,
|
383
|
+
:windows_configuration,
|
384
|
+
:lustre_configuration)
|
385
|
+
include Aws::Structure
|
386
|
+
end
|
387
|
+
|
388
|
+
# The response object for the `CreateFileSystem` operation.
|
389
|
+
#
|
390
|
+
# @!attribute [rw] file_system
|
391
|
+
# A description of the file system.
|
392
|
+
# @return [Types::FileSystem]
|
393
|
+
#
|
394
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemResponse AWS API Documentation
|
395
|
+
#
|
396
|
+
class CreateFileSystemResponse < Struct.new(
|
397
|
+
:file_system)
|
398
|
+
include Aws::Structure
|
399
|
+
end
|
400
|
+
|
401
|
+
# The configuration object for the Microsoft Windows file system used in
|
402
|
+
# `CreateFileSystem` and `CreateFileSystemFromBackup` operations.
|
403
|
+
#
|
404
|
+
# @note When making an API call, you may pass CreateFileSystemWindowsConfiguration
|
405
|
+
# data as a hash:
|
406
|
+
#
|
407
|
+
# {
|
408
|
+
# active_directory_id: "DirectoryId",
|
409
|
+
# throughput_capacity: 1, # required
|
410
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
411
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
412
|
+
# automatic_backup_retention_days: 1,
|
413
|
+
# copy_tags_to_backups: false,
|
414
|
+
# }
|
415
|
+
#
|
416
|
+
# @!attribute [rw] active_directory_id
|
417
|
+
# The ID for an existing Microsoft Active Directory instance that the
|
418
|
+
# file system should join when it's created.
|
419
|
+
# @return [String]
|
420
|
+
#
|
421
|
+
# @!attribute [rw] throughput_capacity
|
422
|
+
# The throughput of an Amazon FSx file system, measured in megabytes
|
423
|
+
# per second.
|
424
|
+
# @return [Integer]
|
425
|
+
#
|
426
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
427
|
+
# The preferred start time to perform weekly maintenance, in the UTC
|
428
|
+
# time zone.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] daily_automatic_backup_start_time
|
432
|
+
# The preferred time to take daily automatic backups, in the UTC time
|
433
|
+
# zone.
|
434
|
+
# @return [String]
|
435
|
+
#
|
436
|
+
# @!attribute [rw] automatic_backup_retention_days
|
437
|
+
# The number of days to retain automatic backups. The default is to
|
438
|
+
# retain backups for 7 days. Setting this value to 0 disables the
|
439
|
+
# creation of automatic backups. The maximum retention period for
|
440
|
+
# backups is 35 days.
|
441
|
+
# @return [Integer]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] copy_tags_to_backups
|
444
|
+
# A boolean flag indicating whether tags on the file system should be
|
445
|
+
# copied to backups. This value defaults to false. If it's set to
|
446
|
+
# true, all tags on the file system are copied to all automatic
|
447
|
+
# backups and any user-initiated backups where the user doesn't
|
448
|
+
# specify any tags. If this value is true, and you specify one or more
|
449
|
+
# tags, only the specified tags are copied to backups.
|
450
|
+
# @return [Boolean]
|
451
|
+
#
|
452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemWindowsConfiguration AWS API Documentation
|
453
|
+
#
|
454
|
+
class CreateFileSystemWindowsConfiguration < Struct.new(
|
455
|
+
:active_directory_id,
|
456
|
+
:throughput_capacity,
|
457
|
+
:weekly_maintenance_start_time,
|
458
|
+
:daily_automatic_backup_start_time,
|
459
|
+
:automatic_backup_retention_days,
|
460
|
+
:copy_tags_to_backups)
|
461
|
+
include Aws::Structure
|
462
|
+
end
|
463
|
+
|
464
|
+
# The data repository configuration object for Lustre file systems
|
465
|
+
# returned in the response of the `CreateFileSystem` operation.
|
466
|
+
#
|
467
|
+
# @!attribute [rw] import_path
|
468
|
+
# The import path to the Amazon S3 bucket (and optional prefix) that
|
469
|
+
# you're using as the data repository for your FSx for Lustre file
|
470
|
+
# system, for example `s3://import-bucket/optional-prefix`. If a
|
471
|
+
# prefix is specified after the Amazon S3 bucket name, only object
|
472
|
+
# keys with that prefix are loaded into the file system.
|
473
|
+
# @return [String]
|
474
|
+
#
|
475
|
+
# @!attribute [rw] export_path
|
476
|
+
# The Amazon S3 commit path to use for storing new and changed Lustre
|
477
|
+
# file system files as part of the archive operation from the file
|
478
|
+
# system to Amazon S3. The value is
|
479
|
+
# `s3://import-bucket/FSxLustre[creationtimestamp]`. The timestamp is
|
480
|
+
# presented in UTC format, for example
|
481
|
+
# `s3://import-bucket/FSxLustre20181105T222312Z`. Files are archived
|
482
|
+
# to a different prefix in the Amazon S3 bucket, preventing input data
|
483
|
+
# from being overwritten.
|
484
|
+
# @return [String]
|
485
|
+
#
|
486
|
+
# @!attribute [rw] imported_file_chunk_size
|
487
|
+
# For files imported from a data repository, this value determines the
|
488
|
+
# stripe count and maximum amount of data per file (in MiB) stored on
|
489
|
+
# a single physical disk. The maximum number of disks that a single
|
490
|
+
# file can be striped across is limited by the total number of disks
|
491
|
+
# that make up the file system.
|
492
|
+
#
|
493
|
+
# The default chunk size is 1,024 MiB (1 GiB) and can go as high as
|
494
|
+
# 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5
|
495
|
+
# TB.
|
496
|
+
# @return [Integer]
|
497
|
+
#
|
498
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryConfiguration AWS API Documentation
|
499
|
+
#
|
500
|
+
class DataRepositoryConfiguration < Struct.new(
|
501
|
+
:import_path,
|
502
|
+
:export_path,
|
503
|
+
:imported_file_chunk_size)
|
504
|
+
include Aws::Structure
|
505
|
+
end
|
506
|
+
|
507
|
+
# The request object for `DeleteBackup` operation.
|
508
|
+
#
|
509
|
+
# @note When making an API call, you may pass DeleteBackupRequest
|
510
|
+
# data as a hash:
|
511
|
+
#
|
512
|
+
# {
|
513
|
+
# backup_id: "BackupId", # required
|
514
|
+
# client_request_token: "ClientRequestToken",
|
515
|
+
# }
|
516
|
+
#
|
517
|
+
# @!attribute [rw] backup_id
|
518
|
+
# The ID of the backup you want to delete.
|
519
|
+
# @return [String]
|
520
|
+
#
|
521
|
+
# @!attribute [rw] client_request_token
|
522
|
+
# (Optional) A string of up to 64 ASCII characters that Amazon FSx
|
523
|
+
# uses to ensure idempotent deletion. This is automatically filled on
|
524
|
+
# your behalf when using the AWS CLI or SDK.
|
525
|
+
#
|
526
|
+
# **A suitable default value is auto-generated.** You should normally
|
527
|
+
# not need to pass this option.
|
528
|
+
# @return [String]
|
529
|
+
#
|
530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackupRequest AWS API Documentation
|
531
|
+
#
|
532
|
+
class DeleteBackupRequest < Struct.new(
|
533
|
+
:backup_id,
|
534
|
+
:client_request_token)
|
535
|
+
include Aws::Structure
|
536
|
+
end
|
537
|
+
|
538
|
+
# The response object for `DeleteBackup` operation.
|
539
|
+
#
|
540
|
+
# @!attribute [rw] backup_id
|
541
|
+
# The ID of the backup deleted.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] lifecycle
|
545
|
+
# The lifecycle of the backup. Should be `DELETED`.
|
546
|
+
# @return [String]
|
547
|
+
#
|
548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteBackupResponse AWS API Documentation
|
549
|
+
#
|
550
|
+
class DeleteBackupResponse < Struct.new(
|
551
|
+
:backup_id,
|
552
|
+
:lifecycle)
|
553
|
+
include Aws::Structure
|
554
|
+
end
|
555
|
+
|
556
|
+
# The request object for `DeleteFileSystem` operation.
|
557
|
+
#
|
558
|
+
# @note When making an API call, you may pass DeleteFileSystemRequest
|
559
|
+
# data as a hash:
|
560
|
+
#
|
561
|
+
# {
|
562
|
+
# file_system_id: "FileSystemId", # required
|
563
|
+
# client_request_token: "ClientRequestToken",
|
564
|
+
# windows_configuration: {
|
565
|
+
# skip_final_backup: false,
|
566
|
+
# final_backup_tags: [
|
567
|
+
# {
|
568
|
+
# key: "TagKey",
|
569
|
+
# value: "TagValue",
|
570
|
+
# },
|
571
|
+
# ],
|
572
|
+
# },
|
573
|
+
# }
|
574
|
+
#
|
575
|
+
# @!attribute [rw] file_system_id
|
576
|
+
# The ID of the file system you want to delete.
|
577
|
+
# @return [String]
|
578
|
+
#
|
579
|
+
# @!attribute [rw] client_request_token
|
580
|
+
# (Optional) A string of up to 64 ASCII characters that Amazon FSx
|
581
|
+
# uses to ensure idempotent deletion. This is automatically filled on
|
582
|
+
# your behalf when using the AWS CLI or SDK.
|
583
|
+
#
|
584
|
+
# **A suitable default value is auto-generated.** You should normally
|
585
|
+
# not need to pass this option.
|
586
|
+
# @return [String]
|
587
|
+
#
|
588
|
+
# @!attribute [rw] windows_configuration
|
589
|
+
# The configuration object for the Microsoft Windows file system used
|
590
|
+
# in the `DeleteFileSystem` operation.
|
591
|
+
# @return [Types::DeleteFileSystemWindowsConfiguration]
|
592
|
+
#
|
593
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemRequest AWS API Documentation
|
594
|
+
#
|
595
|
+
class DeleteFileSystemRequest < Struct.new(
|
596
|
+
:file_system_id,
|
597
|
+
:client_request_token,
|
598
|
+
:windows_configuration)
|
599
|
+
include Aws::Structure
|
600
|
+
end
|
601
|
+
|
602
|
+
# The response object for the `DeleteFileSystem` operation.
|
603
|
+
#
|
604
|
+
# @!attribute [rw] file_system_id
|
605
|
+
# The ID of the file system being deleted.
|
606
|
+
# @return [String]
|
607
|
+
#
|
608
|
+
# @!attribute [rw] lifecycle
|
609
|
+
# The file system lifecycle for the deletion request. Should be
|
610
|
+
# `DELETING`.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @!attribute [rw] windows_response
|
614
|
+
# The response object for the Microsoft Windows file system used in
|
615
|
+
# the `DeleteFileSystem` operation.
|
616
|
+
# @return [Types::DeleteFileSystemWindowsResponse]
|
617
|
+
#
|
618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemResponse AWS API Documentation
|
619
|
+
#
|
620
|
+
class DeleteFileSystemResponse < Struct.new(
|
621
|
+
:file_system_id,
|
622
|
+
:lifecycle,
|
623
|
+
:windows_response)
|
624
|
+
include Aws::Structure
|
625
|
+
end
|
626
|
+
|
627
|
+
# The configuration object for the Microsoft Windows file system used in
|
628
|
+
# the `DeleteFileSystem` operation.
|
629
|
+
#
|
630
|
+
# @note When making an API call, you may pass DeleteFileSystemWindowsConfiguration
|
631
|
+
# data as a hash:
|
632
|
+
#
|
633
|
+
# {
|
634
|
+
# skip_final_backup: false,
|
635
|
+
# final_backup_tags: [
|
636
|
+
# {
|
637
|
+
# key: "TagKey",
|
638
|
+
# value: "TagValue",
|
639
|
+
# },
|
640
|
+
# ],
|
641
|
+
# }
|
642
|
+
#
|
643
|
+
# @!attribute [rw] skip_final_backup
|
644
|
+
# By default, Amazon FSx for Windows takes a final backup on your
|
645
|
+
# behalf when the `DeleteFileSystem` operation is invoked. Doing this
|
646
|
+
# helps protect you from data loss, and we highly recommend taking the
|
647
|
+
# final backup. If you want to skip this backup, use this flag to do
|
648
|
+
# so.
|
649
|
+
# @return [Boolean]
|
650
|
+
#
|
651
|
+
# @!attribute [rw] final_backup_tags
|
652
|
+
# A set of tags for your final backup.
|
653
|
+
# @return [Array<Types::Tag>]
|
654
|
+
#
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemWindowsConfiguration AWS API Documentation
|
656
|
+
#
|
657
|
+
class DeleteFileSystemWindowsConfiguration < Struct.new(
|
658
|
+
:skip_final_backup,
|
659
|
+
:final_backup_tags)
|
660
|
+
include Aws::Structure
|
661
|
+
end
|
662
|
+
|
663
|
+
# The response object for the Microsoft Windows file system used in the
|
664
|
+
# `DeleteFileSystem` operation.
|
665
|
+
#
|
666
|
+
# @!attribute [rw] final_backup_id
|
667
|
+
# The ID of the final backup for this file system.
|
668
|
+
# @return [String]
|
669
|
+
#
|
670
|
+
# @!attribute [rw] final_backup_tags
|
671
|
+
# The set of tags applied to the final backup.
|
672
|
+
# @return [Array<Types::Tag>]
|
673
|
+
#
|
674
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteFileSystemWindowsResponse AWS API Documentation
|
675
|
+
#
|
676
|
+
class DeleteFileSystemWindowsResponse < Struct.new(
|
677
|
+
:final_backup_id,
|
678
|
+
:final_backup_tags)
|
679
|
+
include Aws::Structure
|
680
|
+
end
|
681
|
+
|
682
|
+
# The request object for `DescribeBackups` operation.
|
683
|
+
#
|
684
|
+
# @note When making an API call, you may pass DescribeBackupsRequest
|
685
|
+
# data as a hash:
|
686
|
+
#
|
687
|
+
# {
|
688
|
+
# backup_ids: ["BackupId"],
|
689
|
+
# filters: [
|
690
|
+
# {
|
691
|
+
# name: "file-system-id", # accepts file-system-id, backup-type
|
692
|
+
# values: ["FilterValue"],
|
693
|
+
# },
|
694
|
+
# ],
|
695
|
+
# max_results: 1,
|
696
|
+
# next_token: "NextToken",
|
697
|
+
# }
|
698
|
+
#
|
699
|
+
# @!attribute [rw] backup_ids
|
700
|
+
# (Optional) IDs of the backups you want to retrieve (String). This
|
701
|
+
# overrides any filters. If any IDs are not found, BackupNotFound will
|
702
|
+
# be thrown.
|
703
|
+
# @return [Array<String>]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] filters
|
706
|
+
# (Optional) Filters structure. Supported names are file-system-id and
|
707
|
+
# backup-type.
|
708
|
+
# @return [Array<Types::Filter>]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] max_results
|
711
|
+
# (Optional) Maximum number of backups to return in the response
|
712
|
+
# (integer). This parameter value must be greater than 0. The number
|
713
|
+
# of items that Amazon FSx returns is the minimum of the `MaxResults`
|
714
|
+
# parameter specified in the request and the service's internal
|
715
|
+
# maximum number of items per page.
|
716
|
+
# @return [Integer]
|
717
|
+
#
|
718
|
+
# @!attribute [rw] next_token
|
719
|
+
# (Optional) Opaque pagination token returned from a previous
|
720
|
+
# `DescribeBackups` operation (String). If a token present, the action
|
721
|
+
# continues the list from where the returning call left off.
|
722
|
+
# @return [String]
|
723
|
+
#
|
724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackupsRequest AWS API Documentation
|
725
|
+
#
|
726
|
+
class DescribeBackupsRequest < Struct.new(
|
727
|
+
:backup_ids,
|
728
|
+
:filters,
|
729
|
+
:max_results,
|
730
|
+
:next_token)
|
731
|
+
include Aws::Structure
|
732
|
+
end
|
733
|
+
|
734
|
+
# Response object for `DescribeBackups` operation.
|
735
|
+
#
|
736
|
+
# @!attribute [rw] backups
|
737
|
+
# Any array of backups.
|
738
|
+
# @return [Array<Types::Backup>]
|
739
|
+
#
|
740
|
+
# @!attribute [rw] next_token
|
741
|
+
# This is present if there are more backups than returned in the
|
742
|
+
# response (String). You can use the `NextToken` value in the later
|
743
|
+
# request to fetch the backups.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackupsResponse AWS API Documentation
|
747
|
+
#
|
748
|
+
class DescribeBackupsResponse < Struct.new(
|
749
|
+
:backups,
|
750
|
+
:next_token)
|
751
|
+
include Aws::Structure
|
752
|
+
end
|
753
|
+
|
754
|
+
# The request object for `DescribeFileSystems` operation.
|
755
|
+
#
|
756
|
+
# @note When making an API call, you may pass DescribeFileSystemsRequest
|
757
|
+
# data as a hash:
|
758
|
+
#
|
759
|
+
# {
|
760
|
+
# file_system_ids: ["FileSystemId"],
|
761
|
+
# max_results: 1,
|
762
|
+
# next_token: "NextToken",
|
763
|
+
# }
|
764
|
+
#
|
765
|
+
# @!attribute [rw] file_system_ids
|
766
|
+
# (Optional) IDs of the file systems whose descriptions you want to
|
767
|
+
# retrieve (String).
|
768
|
+
# @return [Array<String>]
|
769
|
+
#
|
770
|
+
# @!attribute [rw] max_results
|
771
|
+
# (Optional) Maximum number of file systems to return in the response
|
772
|
+
# (integer). This parameter value must be greater than 0. The number
|
773
|
+
# of items that Amazon FSx returns is the minimum of the `MaxResults`
|
774
|
+
# parameter specified in the request and the service's internal
|
775
|
+
# maximum number of items per page.
|
776
|
+
# @return [Integer]
|
777
|
+
#
|
778
|
+
# @!attribute [rw] next_token
|
779
|
+
# (Optional) Opaque pagination token returned from a previous
|
780
|
+
# `DescribeFileSystems` operation (String). If a token present, the
|
781
|
+
# action continues the list from where the returning call left off.
|
782
|
+
# @return [String]
|
783
|
+
#
|
784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemsRequest AWS API Documentation
|
785
|
+
#
|
786
|
+
class DescribeFileSystemsRequest < Struct.new(
|
787
|
+
:file_system_ids,
|
788
|
+
:max_results,
|
789
|
+
:next_token)
|
790
|
+
include Aws::Structure
|
791
|
+
end
|
792
|
+
|
793
|
+
# The response object for `DescribeFileSystems` operation.
|
794
|
+
#
|
795
|
+
# @!attribute [rw] file_systems
|
796
|
+
# An array of file system descriptions.
|
797
|
+
# @return [Array<Types::FileSystem>]
|
798
|
+
#
|
799
|
+
# @!attribute [rw] next_token
|
800
|
+
# Present if there are more file systems than returned in the response
|
801
|
+
# (String). You can use the `NextToken` value in the later request to
|
802
|
+
# fetch the descriptions.
|
803
|
+
# @return [String]
|
804
|
+
#
|
805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemsResponse AWS API Documentation
|
806
|
+
#
|
807
|
+
class DescribeFileSystemsResponse < Struct.new(
|
808
|
+
:file_systems,
|
809
|
+
:next_token)
|
810
|
+
include Aws::Structure
|
811
|
+
end
|
812
|
+
|
813
|
+
# A description of a specific Amazon FSx file system.
|
814
|
+
#
|
815
|
+
# @!attribute [rw] owner_id
|
816
|
+
# The AWS account that created the file system. If the file system was
|
817
|
+
# created by an IAM user, the AWS account to which the IAM user
|
818
|
+
# belongs is the owner.
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @!attribute [rw] creation_time
|
822
|
+
# The time that the file system was created, in seconds (since
|
823
|
+
# 1970-01-01T00:00:00Z), also known as Unix time.
|
824
|
+
# @return [Time]
|
825
|
+
#
|
826
|
+
# @!attribute [rw] file_system_id
|
827
|
+
# The eight-digit ID of the file system that was automatically
|
828
|
+
# assigned by Amazon FSx.
|
829
|
+
# @return [String]
|
830
|
+
#
|
831
|
+
# @!attribute [rw] file_system_type
|
832
|
+
# Type of file system. Currently the only supported type is WINDOWS.
|
833
|
+
# @return [String]
|
834
|
+
#
|
835
|
+
# @!attribute [rw] lifecycle
|
836
|
+
# The lifecycle status of the file system.
|
837
|
+
# @return [String]
|
838
|
+
#
|
839
|
+
# @!attribute [rw] failure_details
|
840
|
+
# Structure providing details of any failures that occur when creating
|
841
|
+
# the file system has failed.
|
842
|
+
# @return [Types::FileSystemFailureDetails]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] storage_capacity
|
845
|
+
# The storage capacity of the file system in gigabytes.
|
846
|
+
# @return [Integer]
|
847
|
+
#
|
848
|
+
# @!attribute [rw] vpc_id
|
849
|
+
# The ID of the primary VPC for the file system.
|
850
|
+
# @return [String]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] subnet_ids
|
853
|
+
# The IDs of the subnets to contain the endpoint for the file system.
|
854
|
+
# One and only one is supported. The file system is launched in the
|
855
|
+
# Availability Zone associated with this subnet.
|
856
|
+
# @return [Array<String>]
|
857
|
+
#
|
858
|
+
# @!attribute [rw] network_interface_ids
|
859
|
+
# The IDs of the elastic network interface from which a specific file
|
860
|
+
# system is accessible. The elastic network interface is automatically
|
861
|
+
# created in the same VPC that the Amazon FSx file system was created
|
862
|
+
# in. For more information, see [Elastic Network Interfaces][1] in the
|
863
|
+
# *Amazon EC2 User Guide.*
|
864
|
+
#
|
865
|
+
# For an Amazon FSx for Windows File Server file system, you can have
|
866
|
+
# one network interface Id. For an Amazon FSx for Lustre file system,
|
867
|
+
# you can have more than one.
|
868
|
+
#
|
869
|
+
#
|
870
|
+
#
|
871
|
+
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html
|
872
|
+
# @return [Array<String>]
|
873
|
+
#
|
874
|
+
# @!attribute [rw] dns_name
|
875
|
+
# The DNS name for the file system.
|
876
|
+
# @return [String]
|
877
|
+
#
|
878
|
+
# @!attribute [rw] kms_key_id
|
879
|
+
# The ID of the AWS Key Management Service (AWS KMS) key used to
|
880
|
+
# encrypt the file system's data for an Amazon FSx for Windows File
|
881
|
+
# Server file system.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @!attribute [rw] resource_arn
|
885
|
+
# The resource ARN of the file system.
|
886
|
+
# @return [String]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] tags
|
889
|
+
# The tags to associate with the file system. For more information,
|
890
|
+
# see [Tagging Your Amazon EC2 Resources][1] in the *Amazon EC2 User
|
891
|
+
# Guide*.
|
892
|
+
#
|
893
|
+
#
|
894
|
+
#
|
895
|
+
# [1]: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html
|
896
|
+
# @return [Array<Types::Tag>]
|
897
|
+
#
|
898
|
+
# @!attribute [rw] windows_configuration
|
899
|
+
# The configuration for this Microsoft Windows file system.
|
900
|
+
# @return [Types::WindowsFileSystemConfiguration]
|
901
|
+
#
|
902
|
+
# @!attribute [rw] lustre_configuration
|
903
|
+
# The configuration for the Amazon FSx for Lustre file system.
|
904
|
+
# @return [Types::LustreFileSystemConfiguration]
|
905
|
+
#
|
906
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystem AWS API Documentation
|
907
|
+
#
|
908
|
+
class FileSystem < Struct.new(
|
909
|
+
:owner_id,
|
910
|
+
:creation_time,
|
911
|
+
:file_system_id,
|
912
|
+
:file_system_type,
|
913
|
+
:lifecycle,
|
914
|
+
:failure_details,
|
915
|
+
:storage_capacity,
|
916
|
+
:vpc_id,
|
917
|
+
:subnet_ids,
|
918
|
+
:network_interface_ids,
|
919
|
+
:dns_name,
|
920
|
+
:kms_key_id,
|
921
|
+
:resource_arn,
|
922
|
+
:tags,
|
923
|
+
:windows_configuration,
|
924
|
+
:lustre_configuration)
|
925
|
+
include Aws::Structure
|
926
|
+
end
|
927
|
+
|
928
|
+
# Structure providing details of any failures that occur when creating
|
929
|
+
# the file system has failed.
|
930
|
+
#
|
931
|
+
# @!attribute [rw] message
|
932
|
+
# Message describing the failures that occurred during file system
|
933
|
+
# creation.
|
934
|
+
# @return [String]
|
935
|
+
#
|
936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/FileSystemFailureDetails AWS API Documentation
|
937
|
+
#
|
938
|
+
class FileSystemFailureDetails < Struct.new(
|
939
|
+
:message)
|
940
|
+
include Aws::Structure
|
941
|
+
end
|
942
|
+
|
943
|
+
# A filter used to restrict the results of describe calls. You can use
|
944
|
+
# multiple filters to return results that meet all applied filter
|
945
|
+
# requirements.
|
946
|
+
#
|
947
|
+
# @note When making an API call, you may pass Filter
|
948
|
+
# data as a hash:
|
949
|
+
#
|
950
|
+
# {
|
951
|
+
# name: "file-system-id", # accepts file-system-id, backup-type
|
952
|
+
# values: ["FilterValue"],
|
953
|
+
# }
|
954
|
+
#
|
955
|
+
# @!attribute [rw] name
|
956
|
+
# The name for this filter.
|
957
|
+
# @return [String]
|
958
|
+
#
|
959
|
+
# @!attribute [rw] values
|
960
|
+
# The values of the filter. These are all the values for any of the
|
961
|
+
# applied filters.
|
962
|
+
# @return [Array<String>]
|
963
|
+
#
|
964
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Filter AWS API Documentation
|
965
|
+
#
|
966
|
+
class Filter < Struct.new(
|
967
|
+
:name,
|
968
|
+
:values)
|
969
|
+
include Aws::Structure
|
970
|
+
end
|
971
|
+
|
972
|
+
# The request object for `ListTagsForResource` operation.
|
973
|
+
#
|
974
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
975
|
+
# data as a hash:
|
976
|
+
#
|
977
|
+
# {
|
978
|
+
# resource_arn: "ResourceARN", # required
|
979
|
+
# max_results: 1,
|
980
|
+
# next_token: "NextToken",
|
981
|
+
# }
|
982
|
+
#
|
983
|
+
# @!attribute [rw] resource_arn
|
984
|
+
# The ARN of the Amazon FSx resource that will have its tags listed.
|
985
|
+
# @return [String]
|
986
|
+
#
|
987
|
+
# @!attribute [rw] max_results
|
988
|
+
# (Optional) Maximum number of tags to return in the response
|
989
|
+
# (integer). This parameter value must be greater than 0. The number
|
990
|
+
# of items that Amazon FSx returns is the minimum of the `MaxResults`
|
991
|
+
# parameter specified in the request and the service's internal
|
992
|
+
# maximum number of items per page.
|
993
|
+
# @return [Integer]
|
994
|
+
#
|
995
|
+
# @!attribute [rw] next_token
|
996
|
+
# (Optional) Opaque pagination token returned from a previous
|
997
|
+
# `ListTagsForResource` operation (String). If a token present, the
|
998
|
+
# action continues the list from where the returning call left off.
|
999
|
+
# @return [String]
|
1000
|
+
#
|
1001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResourceRequest AWS API Documentation
|
1002
|
+
#
|
1003
|
+
class ListTagsForResourceRequest < Struct.new(
|
1004
|
+
:resource_arn,
|
1005
|
+
:max_results,
|
1006
|
+
:next_token)
|
1007
|
+
include Aws::Structure
|
1008
|
+
end
|
1009
|
+
|
1010
|
+
# The response object for `ListTagsForResource` operation.
|
1011
|
+
#
|
1012
|
+
# @!attribute [rw] tags
|
1013
|
+
# A list of tags on the resource.
|
1014
|
+
# @return [Array<Types::Tag>]
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] next_token
|
1017
|
+
# This is present if there are more tags than returned in the response
|
1018
|
+
# (String). You can use the `NextToken` value in the later request to
|
1019
|
+
# fetch the tags.
|
1020
|
+
# @return [String]
|
1021
|
+
#
|
1022
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ListTagsForResourceResponse AWS API Documentation
|
1023
|
+
#
|
1024
|
+
class ListTagsForResourceResponse < Struct.new(
|
1025
|
+
:tags,
|
1026
|
+
:next_token)
|
1027
|
+
include Aws::Structure
|
1028
|
+
end
|
1029
|
+
|
1030
|
+
# The configuration for the Amazon FSx for Lustre file system.
|
1031
|
+
#
|
1032
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
1033
|
+
# The UTC time that you want to begin your weekly maintenance window.
|
1034
|
+
# @return [String]
|
1035
|
+
#
|
1036
|
+
# @!attribute [rw] data_repository_configuration
|
1037
|
+
# The data repository configuration object for Lustre file systems
|
1038
|
+
# returned in the response of the `CreateFileSystem` operation.
|
1039
|
+
# @return [Types::DataRepositoryConfiguration]
|
1040
|
+
#
|
1041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/LustreFileSystemConfiguration AWS API Documentation
|
1042
|
+
#
|
1043
|
+
class LustreFileSystemConfiguration < Struct.new(
|
1044
|
+
:weekly_maintenance_start_time,
|
1045
|
+
:data_repository_configuration)
|
1046
|
+
include Aws::Structure
|
1047
|
+
end
|
1048
|
+
|
1049
|
+
# Specifies a key-value pair for a resource tag.
|
1050
|
+
#
|
1051
|
+
# @note When making an API call, you may pass Tag
|
1052
|
+
# data as a hash:
|
1053
|
+
#
|
1054
|
+
# {
|
1055
|
+
# key: "TagKey",
|
1056
|
+
# value: "TagValue",
|
1057
|
+
# }
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] key
|
1060
|
+
# A value that specifies the `TagKey`, the name of the tag. Tag keys
|
1061
|
+
# must be unique for the resource to which they are attached.
|
1062
|
+
# @return [String]
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] value
|
1065
|
+
# A value that specifies the `TagValue`, the value assigned to the
|
1066
|
+
# corresponding tag key. Tag values can be null and don't have to be
|
1067
|
+
# unique in a tag set. For example, you can have a key-value pair in a
|
1068
|
+
# tag set of `finances : April` and also of `payroll : April`.
|
1069
|
+
# @return [String]
|
1070
|
+
#
|
1071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Tag AWS API Documentation
|
1072
|
+
#
|
1073
|
+
class Tag < Struct.new(
|
1074
|
+
:key,
|
1075
|
+
:value)
|
1076
|
+
include Aws::Structure
|
1077
|
+
end
|
1078
|
+
|
1079
|
+
# The request object for the `TagResource` operation.
|
1080
|
+
#
|
1081
|
+
# @note When making an API call, you may pass TagResourceRequest
|
1082
|
+
# data as a hash:
|
1083
|
+
#
|
1084
|
+
# {
|
1085
|
+
# resource_arn: "ResourceARN", # required
|
1086
|
+
# tags: [ # required
|
1087
|
+
# {
|
1088
|
+
# key: "TagKey",
|
1089
|
+
# value: "TagValue",
|
1090
|
+
# },
|
1091
|
+
# ],
|
1092
|
+
# }
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] resource_arn
|
1095
|
+
# The Amazon Resource Name (ARN) of the Amazon FSx resource that you
|
1096
|
+
# want to tag.
|
1097
|
+
# @return [String]
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] tags
|
1100
|
+
# A list of tags for the resource. If a tag with a given key already
|
1101
|
+
# exists, the value is replaced by the one specified in this
|
1102
|
+
# parameter.
|
1103
|
+
# @return [Array<Types::Tag>]
|
1104
|
+
#
|
1105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceRequest AWS API Documentation
|
1106
|
+
#
|
1107
|
+
class TagResourceRequest < Struct.new(
|
1108
|
+
:resource_arn,
|
1109
|
+
:tags)
|
1110
|
+
include Aws::Structure
|
1111
|
+
end
|
1112
|
+
|
1113
|
+
# The response object for the `TagResource` operation.
|
1114
|
+
#
|
1115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/TagResourceResponse AWS API Documentation
|
1116
|
+
#
|
1117
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1118
|
+
|
1119
|
+
# The request object for `UntagResource` action.
|
1120
|
+
#
|
1121
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
1122
|
+
# data as a hash:
|
1123
|
+
#
|
1124
|
+
# {
|
1125
|
+
# resource_arn: "ResourceARN", # required
|
1126
|
+
# tag_keys: ["TagKey"], # required
|
1127
|
+
# }
|
1128
|
+
#
|
1129
|
+
# @!attribute [rw] resource_arn
|
1130
|
+
# The ARN of the Amazon FSx resource to untag.
|
1131
|
+
# @return [String]
|
1132
|
+
#
|
1133
|
+
# @!attribute [rw] tag_keys
|
1134
|
+
# A list of keys of tags on the resource to untag. In case the tag key
|
1135
|
+
# doesn't exist, the call will still succeed to be idempotent.
|
1136
|
+
# @return [Array<String>]
|
1137
|
+
#
|
1138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResourceRequest AWS API Documentation
|
1139
|
+
#
|
1140
|
+
class UntagResourceRequest < Struct.new(
|
1141
|
+
:resource_arn,
|
1142
|
+
:tag_keys)
|
1143
|
+
include Aws::Structure
|
1144
|
+
end
|
1145
|
+
|
1146
|
+
# The response object for `UntagResource` action.
|
1147
|
+
#
|
1148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UntagResourceResponse AWS API Documentation
|
1149
|
+
#
|
1150
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1151
|
+
|
1152
|
+
# The configuration object for Amazon FSx for Lustre file systems used
|
1153
|
+
# in the `UpdateFileSystem` operation.
|
1154
|
+
#
|
1155
|
+
# @note When making an API call, you may pass UpdateFileSystemLustreConfiguration
|
1156
|
+
# data as a hash:
|
1157
|
+
#
|
1158
|
+
# {
|
1159
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
1160
|
+
# }
|
1161
|
+
#
|
1162
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
1163
|
+
# The preferred time to perform weekly maintenance, in the UTC time
|
1164
|
+
# zone.
|
1165
|
+
# @return [String]
|
1166
|
+
#
|
1167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemLustreConfiguration AWS API Documentation
|
1168
|
+
#
|
1169
|
+
class UpdateFileSystemLustreConfiguration < Struct.new(
|
1170
|
+
:weekly_maintenance_start_time)
|
1171
|
+
include Aws::Structure
|
1172
|
+
end
|
1173
|
+
|
1174
|
+
# The request object for the `UpdateFileSystem` operation.
|
1175
|
+
#
|
1176
|
+
# @note When making an API call, you may pass UpdateFileSystemRequest
|
1177
|
+
# data as a hash:
|
1178
|
+
#
|
1179
|
+
# {
|
1180
|
+
# file_system_id: "FileSystemId", # required
|
1181
|
+
# client_request_token: "ClientRequestToken",
|
1182
|
+
# windows_configuration: {
|
1183
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
1184
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
1185
|
+
# automatic_backup_retention_days: 1,
|
1186
|
+
# },
|
1187
|
+
# lustre_configuration: {
|
1188
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
1189
|
+
# },
|
1190
|
+
# }
|
1191
|
+
#
|
1192
|
+
# @!attribute [rw] file_system_id
|
1193
|
+
# The globally unique ID of the file system, assigned by Amazon FSx.
|
1194
|
+
# @return [String]
|
1195
|
+
#
|
1196
|
+
# @!attribute [rw] client_request_token
|
1197
|
+
# (Optional) A string of up to 64 ASCII characters that Amazon FSx
|
1198
|
+
# uses to ensure idempotent updates. This string is automatically
|
1199
|
+
# filled on your behalf when you use the AWS Command Line Interface
|
1200
|
+
# (AWS CLI) or an AWS SDK.
|
1201
|
+
#
|
1202
|
+
# **A suitable default value is auto-generated.** You should normally
|
1203
|
+
# not need to pass this option.
|
1204
|
+
# @return [String]
|
1205
|
+
#
|
1206
|
+
# @!attribute [rw] windows_configuration
|
1207
|
+
# The configuration for this Microsoft Windows file system. The only
|
1208
|
+
# supported options are for backup and maintenance.
|
1209
|
+
# @return [Types::UpdateFileSystemWindowsConfiguration]
|
1210
|
+
#
|
1211
|
+
# @!attribute [rw] lustre_configuration
|
1212
|
+
# The configuration object for Amazon FSx for Lustre file systems used
|
1213
|
+
# in the `UpdateFileSystem` operation.
|
1214
|
+
# @return [Types::UpdateFileSystemLustreConfiguration]
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemRequest AWS API Documentation
|
1217
|
+
#
|
1218
|
+
class UpdateFileSystemRequest < Struct.new(
|
1219
|
+
:file_system_id,
|
1220
|
+
:client_request_token,
|
1221
|
+
:windows_configuration,
|
1222
|
+
:lustre_configuration)
|
1223
|
+
include Aws::Structure
|
1224
|
+
end
|
1225
|
+
|
1226
|
+
# The response object for the `UpdateFileSystem` operation.
|
1227
|
+
#
|
1228
|
+
# @!attribute [rw] file_system
|
1229
|
+
# A description of the file system.
|
1230
|
+
# @return [Types::FileSystem]
|
1231
|
+
#
|
1232
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemResponse AWS API Documentation
|
1233
|
+
#
|
1234
|
+
class UpdateFileSystemResponse < Struct.new(
|
1235
|
+
:file_system)
|
1236
|
+
include Aws::Structure
|
1237
|
+
end
|
1238
|
+
|
1239
|
+
# The configuration object for the Microsoft Windows file system used in
|
1240
|
+
# the `UpdateFileSystem` operation.
|
1241
|
+
#
|
1242
|
+
# @note When making an API call, you may pass UpdateFileSystemWindowsConfiguration
|
1243
|
+
# data as a hash:
|
1244
|
+
#
|
1245
|
+
# {
|
1246
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
1247
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
1248
|
+
# automatic_backup_retention_days: 1,
|
1249
|
+
# }
|
1250
|
+
#
|
1251
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
1252
|
+
# The preferred time to perform weekly maintenance, in the UTC time
|
1253
|
+
# zone.
|
1254
|
+
# @return [String]
|
1255
|
+
#
|
1256
|
+
# @!attribute [rw] daily_automatic_backup_start_time
|
1257
|
+
# The preferred time to take daily automatic backups, in the UTC time
|
1258
|
+
# zone.
|
1259
|
+
# @return [String]
|
1260
|
+
#
|
1261
|
+
# @!attribute [rw] automatic_backup_retention_days
|
1262
|
+
# The number of days to retain automatic backups. Setting this to 0
|
1263
|
+
# disables automatic backups. You can retain automatic backups for a
|
1264
|
+
# maximum of 35 days.
|
1265
|
+
# @return [Integer]
|
1266
|
+
#
|
1267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemWindowsConfiguration AWS API Documentation
|
1268
|
+
#
|
1269
|
+
class UpdateFileSystemWindowsConfiguration < Struct.new(
|
1270
|
+
:weekly_maintenance_start_time,
|
1271
|
+
:daily_automatic_backup_start_time,
|
1272
|
+
:automatic_backup_retention_days)
|
1273
|
+
include Aws::Structure
|
1274
|
+
end
|
1275
|
+
|
1276
|
+
# The configuration for this Microsoft Windows file system.
|
1277
|
+
#
|
1278
|
+
# @!attribute [rw] active_directory_id
|
1279
|
+
# The ID for an existing Microsoft Active Directory instance that the
|
1280
|
+
# file system should join when it's created.
|
1281
|
+
# @return [String]
|
1282
|
+
#
|
1283
|
+
# @!attribute [rw] throughput_capacity
|
1284
|
+
# The throughput of an Amazon FSx file system, measured in megabytes
|
1285
|
+
# per second.
|
1286
|
+
# @return [Integer]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] maintenance_operations_in_progress
|
1289
|
+
# The list of maintenance operations in progress for this file system.
|
1290
|
+
# @return [Array<String>]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] weekly_maintenance_start_time
|
1293
|
+
# The preferred time to perform weekly maintenance, in the UTC time
|
1294
|
+
# zone.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] daily_automatic_backup_start_time
|
1298
|
+
# The preferred time to take daily automatic backups, in the UTC time
|
1299
|
+
# zone.
|
1300
|
+
# @return [String]
|
1301
|
+
#
|
1302
|
+
# @!attribute [rw] automatic_backup_retention_days
|
1303
|
+
# The number of days to retain automatic backups. Setting this to 0
|
1304
|
+
# disables automatic backups. You can retain automatic backups for a
|
1305
|
+
# maximum of 35 days.
|
1306
|
+
# @return [Integer]
|
1307
|
+
#
|
1308
|
+
# @!attribute [rw] copy_tags_to_backups
|
1309
|
+
# A boolean flag indicating whether tags on the file system should be
|
1310
|
+
# copied to backups. This value defaults to false. If it's set to
|
1311
|
+
# true, all tags on the file system are copied to all automatic
|
1312
|
+
# backups and any user-initiated backups where the user doesn't
|
1313
|
+
# specify any tags. If this value is true, and you specify one or more
|
1314
|
+
# tags, only the specified tags are copied to backups.
|
1315
|
+
# @return [Boolean]
|
1316
|
+
#
|
1317
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsFileSystemConfiguration AWS API Documentation
|
1318
|
+
#
|
1319
|
+
class WindowsFileSystemConfiguration < Struct.new(
|
1320
|
+
:active_directory_id,
|
1321
|
+
:throughput_capacity,
|
1322
|
+
:maintenance_operations_in_progress,
|
1323
|
+
:weekly_maintenance_start_time,
|
1324
|
+
:daily_automatic_backup_start_time,
|
1325
|
+
:automatic_backup_retention_days,
|
1326
|
+
:copy_tags_to_backups)
|
1327
|
+
include Aws::Structure
|
1328
|
+
end
|
1329
|
+
|
1330
|
+
end
|
1331
|
+
end
|