aws-sdk-fsx 1.27.0 → 1.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-fsx.rb +4 -3
- data/lib/aws-sdk-fsx/client.rb +339 -61
- data/lib/aws-sdk-fsx/client_api.rb +86 -0
- data/lib/aws-sdk-fsx/types.rb +521 -121
- metadata +4 -4
@@ -22,7 +22,14 @@ module Aws::FSx
|
|
22
22
|
AdministrativeActionFailureDetails = Shapes::StructureShape.new(name: 'AdministrativeActionFailureDetails')
|
23
23
|
AdministrativeActionType = Shapes::StringShape.new(name: 'AdministrativeActionType')
|
24
24
|
AdministrativeActions = Shapes::ListShape.new(name: 'AdministrativeActions')
|
25
|
+
Alias = Shapes::StructureShape.new(name: 'Alias')
|
26
|
+
AliasLifecycle = Shapes::StringShape.new(name: 'AliasLifecycle')
|
27
|
+
Aliases = Shapes::ListShape.new(name: 'Aliases')
|
28
|
+
AlternateDNSName = Shapes::StringShape.new(name: 'AlternateDNSName')
|
29
|
+
AlternateDNSNames = Shapes::ListShape.new(name: 'AlternateDNSNames')
|
25
30
|
ArchivePath = Shapes::StringShape.new(name: 'ArchivePath')
|
31
|
+
AssociateFileSystemAliasesRequest = Shapes::StructureShape.new(name: 'AssociateFileSystemAliasesRequest')
|
32
|
+
AssociateFileSystemAliasesResponse = Shapes::StructureShape.new(name: 'AssociateFileSystemAliasesResponse')
|
26
33
|
AutoImportPolicyType = Shapes::StringShape.new(name: 'AutoImportPolicyType')
|
27
34
|
AutomaticBackupRetentionDays = Shapes::IntegerShape.new(name: 'AutomaticBackupRetentionDays')
|
28
35
|
Backup = Shapes::StructureShape.new(name: 'Backup')
|
@@ -84,11 +91,15 @@ module Aws::FSx
|
|
84
91
|
DescribeBackupsResponse = Shapes::StructureShape.new(name: 'DescribeBackupsResponse')
|
85
92
|
DescribeDataRepositoryTasksRequest = Shapes::StructureShape.new(name: 'DescribeDataRepositoryTasksRequest')
|
86
93
|
DescribeDataRepositoryTasksResponse = Shapes::StructureShape.new(name: 'DescribeDataRepositoryTasksResponse')
|
94
|
+
DescribeFileSystemAliasesRequest = Shapes::StructureShape.new(name: 'DescribeFileSystemAliasesRequest')
|
95
|
+
DescribeFileSystemAliasesResponse = Shapes::StructureShape.new(name: 'DescribeFileSystemAliasesResponse')
|
87
96
|
DescribeFileSystemsRequest = Shapes::StructureShape.new(name: 'DescribeFileSystemsRequest')
|
88
97
|
DescribeFileSystemsResponse = Shapes::StructureShape.new(name: 'DescribeFileSystemsResponse')
|
89
98
|
DirectoryId = Shapes::StringShape.new(name: 'DirectoryId')
|
90
99
|
DirectoryPassword = Shapes::StringShape.new(name: 'DirectoryPassword')
|
91
100
|
DirectoryUserName = Shapes::StringShape.new(name: 'DirectoryUserName')
|
101
|
+
DisassociateFileSystemAliasesRequest = Shapes::StructureShape.new(name: 'DisassociateFileSystemAliasesRequest')
|
102
|
+
DisassociateFileSystemAliasesResponse = Shapes::StructureShape.new(name: 'DisassociateFileSystemAliasesResponse')
|
92
103
|
DnsIps = Shapes::ListShape.new(name: 'DnsIps')
|
93
104
|
DriveCacheType = Shapes::StringShape.new(name: 'DriveCacheType')
|
94
105
|
EndTime = Shapes::TimestampShape.new(name: 'EndTime')
|
@@ -201,6 +212,22 @@ module Aws::FSx
|
|
201
212
|
|
202
213
|
AdministrativeActions.member = Shapes::ShapeRef.new(shape: AdministrativeAction)
|
203
214
|
|
215
|
+
Alias.add_member(:name, Shapes::ShapeRef.new(shape: AlternateDNSName, location_name: "Name"))
|
216
|
+
Alias.add_member(:lifecycle, Shapes::ShapeRef.new(shape: AliasLifecycle, location_name: "Lifecycle"))
|
217
|
+
Alias.struct_class = Types::Alias
|
218
|
+
|
219
|
+
Aliases.member = Shapes::ShapeRef.new(shape: Alias)
|
220
|
+
|
221
|
+
AlternateDNSNames.member = Shapes::ShapeRef.new(shape: AlternateDNSName)
|
222
|
+
|
223
|
+
AssociateFileSystemAliasesRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
224
|
+
AssociateFileSystemAliasesRequest.add_member(:file_system_id, Shapes::ShapeRef.new(shape: FileSystemId, required: true, location_name: "FileSystemId"))
|
225
|
+
AssociateFileSystemAliasesRequest.add_member(:aliases, Shapes::ShapeRef.new(shape: AlternateDNSNames, required: true, location_name: "Aliases"))
|
226
|
+
AssociateFileSystemAliasesRequest.struct_class = Types::AssociateFileSystemAliasesRequest
|
227
|
+
|
228
|
+
AssociateFileSystemAliasesResponse.add_member(:aliases, Shapes::ShapeRef.new(shape: Aliases, location_name: "Aliases"))
|
229
|
+
AssociateFileSystemAliasesResponse.struct_class = Types::AssociateFileSystemAliasesResponse
|
230
|
+
|
204
231
|
Backup.add_member(:backup_id, Shapes::ShapeRef.new(shape: BackupId, required: true, location_name: "BackupId"))
|
205
232
|
Backup.add_member(:lifecycle, Shapes::ShapeRef.new(shape: BackupLifecycle, required: true, location_name: "Lifecycle"))
|
206
233
|
Backup.add_member(:failure_details, Shapes::ShapeRef.new(shape: BackupFailureDetails, location_name: "FailureDetails"))
|
@@ -316,6 +343,7 @@ module Aws::FSx
|
|
316
343
|
CreateFileSystemWindowsConfiguration.add_member(:daily_automatic_backup_start_time, Shapes::ShapeRef.new(shape: DailyTime, location_name: "DailyAutomaticBackupStartTime"))
|
317
344
|
CreateFileSystemWindowsConfiguration.add_member(:automatic_backup_retention_days, Shapes::ShapeRef.new(shape: AutomaticBackupRetentionDays, location_name: "AutomaticBackupRetentionDays"))
|
318
345
|
CreateFileSystemWindowsConfiguration.add_member(:copy_tags_to_backups, Shapes::ShapeRef.new(shape: Flag, location_name: "CopyTagsToBackups"))
|
346
|
+
CreateFileSystemWindowsConfiguration.add_member(:aliases, Shapes::ShapeRef.new(shape: AlternateDNSNames, location_name: "Aliases"))
|
319
347
|
CreateFileSystemWindowsConfiguration.struct_class = Types::CreateFileSystemWindowsConfiguration
|
320
348
|
|
321
349
|
DataRepositoryConfiguration.add_member(:lifecycle, Shapes::ShapeRef.new(shape: DataRepositoryLifecycle, location_name: "Lifecycle"))
|
@@ -430,6 +458,16 @@ module Aws::FSx
|
|
430
458
|
DescribeDataRepositoryTasksResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
431
459
|
DescribeDataRepositoryTasksResponse.struct_class = Types::DescribeDataRepositoryTasksResponse
|
432
460
|
|
461
|
+
DescribeFileSystemAliasesRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
462
|
+
DescribeFileSystemAliasesRequest.add_member(:file_system_id, Shapes::ShapeRef.new(shape: FileSystemId, required: true, location_name: "FileSystemId"))
|
463
|
+
DescribeFileSystemAliasesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
464
|
+
DescribeFileSystemAliasesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
465
|
+
DescribeFileSystemAliasesRequest.struct_class = Types::DescribeFileSystemAliasesRequest
|
466
|
+
|
467
|
+
DescribeFileSystemAliasesResponse.add_member(:aliases, Shapes::ShapeRef.new(shape: Aliases, location_name: "Aliases"))
|
468
|
+
DescribeFileSystemAliasesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
469
|
+
DescribeFileSystemAliasesResponse.struct_class = Types::DescribeFileSystemAliasesResponse
|
470
|
+
|
433
471
|
DescribeFileSystemsRequest.add_member(:file_system_ids, Shapes::ShapeRef.new(shape: FileSystemIds, location_name: "FileSystemIds"))
|
434
472
|
DescribeFileSystemsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
435
473
|
DescribeFileSystemsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
@@ -439,6 +477,14 @@ module Aws::FSx
|
|
439
477
|
DescribeFileSystemsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
440
478
|
DescribeFileSystemsResponse.struct_class = Types::DescribeFileSystemsResponse
|
441
479
|
|
480
|
+
DisassociateFileSystemAliasesRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
481
|
+
DisassociateFileSystemAliasesRequest.add_member(:file_system_id, Shapes::ShapeRef.new(shape: FileSystemId, required: true, location_name: "FileSystemId"))
|
482
|
+
DisassociateFileSystemAliasesRequest.add_member(:aliases, Shapes::ShapeRef.new(shape: AlternateDNSNames, required: true, location_name: "Aliases"))
|
483
|
+
DisassociateFileSystemAliasesRequest.struct_class = Types::DisassociateFileSystemAliasesRequest
|
484
|
+
|
485
|
+
DisassociateFileSystemAliasesResponse.add_member(:aliases, Shapes::ShapeRef.new(shape: Aliases, location_name: "Aliases"))
|
486
|
+
DisassociateFileSystemAliasesResponse.struct_class = Types::DisassociateFileSystemAliasesResponse
|
487
|
+
|
442
488
|
DnsIps.member = Shapes::ShapeRef.new(shape: IpAddress)
|
443
489
|
|
444
490
|
FileSystem.add_member(:owner_id, Shapes::ShapeRef.new(shape: AWSAccountId, location_name: "OwnerId"))
|
@@ -627,6 +673,7 @@ module Aws::FSx
|
|
627
673
|
WindowsFileSystemConfiguration.add_member(:daily_automatic_backup_start_time, Shapes::ShapeRef.new(shape: DailyTime, location_name: "DailyAutomaticBackupStartTime"))
|
628
674
|
WindowsFileSystemConfiguration.add_member(:automatic_backup_retention_days, Shapes::ShapeRef.new(shape: AutomaticBackupRetentionDays, location_name: "AutomaticBackupRetentionDays"))
|
629
675
|
WindowsFileSystemConfiguration.add_member(:copy_tags_to_backups, Shapes::ShapeRef.new(shape: Flag, location_name: "CopyTagsToBackups"))
|
676
|
+
WindowsFileSystemConfiguration.add_member(:aliases, Shapes::ShapeRef.new(shape: Aliases, location_name: "Aliases"))
|
630
677
|
WindowsFileSystemConfiguration.struct_class = Types::WindowsFileSystemConfiguration
|
631
678
|
|
632
679
|
|
@@ -648,6 +695,17 @@ module Aws::FSx
|
|
648
695
|
"uid" => "fsx-2018-03-01",
|
649
696
|
}
|
650
697
|
|
698
|
+
api.add_operation(:associate_file_system_aliases, Seahorse::Model::Operation.new.tap do |o|
|
699
|
+
o.name = "AssociateFileSystemAliases"
|
700
|
+
o.http_method = "POST"
|
701
|
+
o.http_request_uri = "/"
|
702
|
+
o.input = Shapes::ShapeRef.new(shape: AssociateFileSystemAliasesRequest)
|
703
|
+
o.output = Shapes::ShapeRef.new(shape: AssociateFileSystemAliasesResponse)
|
704
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequest)
|
705
|
+
o.errors << Shapes::ShapeRef.new(shape: FileSystemNotFound)
|
706
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
707
|
+
end)
|
708
|
+
|
651
709
|
api.add_operation(:cancel_data_repository_task, Seahorse::Model::Operation.new.tap do |o|
|
652
710
|
o.name = "CancelDataRepositoryTask"
|
653
711
|
o.http_method = "POST"
|
@@ -789,6 +847,23 @@ module Aws::FSx
|
|
789
847
|
)
|
790
848
|
end)
|
791
849
|
|
850
|
+
api.add_operation(:describe_file_system_aliases, Seahorse::Model::Operation.new.tap do |o|
|
851
|
+
o.name = "DescribeFileSystemAliases"
|
852
|
+
o.http_method = "POST"
|
853
|
+
o.http_request_uri = "/"
|
854
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeFileSystemAliasesRequest)
|
855
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeFileSystemAliasesResponse)
|
856
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequest)
|
857
|
+
o.errors << Shapes::ShapeRef.new(shape: FileSystemNotFound)
|
858
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
859
|
+
o[:pager] = Aws::Pager.new(
|
860
|
+
limit_key: "max_results",
|
861
|
+
tokens: {
|
862
|
+
"next_token" => "next_token"
|
863
|
+
}
|
864
|
+
)
|
865
|
+
end)
|
866
|
+
|
792
867
|
api.add_operation(:describe_file_systems, Seahorse::Model::Operation.new.tap do |o|
|
793
868
|
o.name = "DescribeFileSystems"
|
794
869
|
o.http_method = "POST"
|
@@ -806,6 +881,17 @@ module Aws::FSx
|
|
806
881
|
)
|
807
882
|
end)
|
808
883
|
|
884
|
+
api.add_operation(:disassociate_file_system_aliases, Seahorse::Model::Operation.new.tap do |o|
|
885
|
+
o.name = "DisassociateFileSystemAliases"
|
886
|
+
o.http_method = "POST"
|
887
|
+
o.http_request_uri = "/"
|
888
|
+
o.input = Shapes::ShapeRef.new(shape: DisassociateFileSystemAliasesRequest)
|
889
|
+
o.output = Shapes::ShapeRef.new(shape: DisassociateFileSystemAliasesResponse)
|
890
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequest)
|
891
|
+
o.errors << Shapes::ShapeRef.new(shape: FileSystemNotFound)
|
892
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerError)
|
893
|
+
end)
|
894
|
+
|
809
895
|
api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
|
810
896
|
o.name = "ListTagsForResource"
|
811
897
|
o.http_method = "POST"
|
data/lib/aws-sdk-fsx/types.rb
CHANGED
@@ -55,34 +55,52 @@ module Aws::FSx
|
|
55
55
|
include Aws::Structure
|
56
56
|
end
|
57
57
|
|
58
|
-
# Describes a specific Amazon FSx
|
59
|
-
# Windows file system.
|
58
|
+
# Describes a specific Amazon FSx administrative action for the current
|
59
|
+
# Windows or Lustre file system.
|
60
60
|
#
|
61
61
|
# @!attribute [rw] administrative_action_type
|
62
62
|
# Describes the type of administrative action, as follows:
|
63
63
|
#
|
64
64
|
# * `FILE_SYSTEM_UPDATE` - A file system update administrative action
|
65
65
|
# initiated by the user from the Amazon FSx console, API
|
66
|
-
# (UpdateFileSystem), or CLI (update-file-system).
|
66
|
+
# (UpdateFileSystem), or CLI (update-file-system).
|
67
67
|
#
|
68
68
|
# * `STORAGE_OPTIMIZATION` - Once the `FILE_SYSTEM_UPDATE` task to
|
69
69
|
# increase a file system's storage capacity completes successfully,
|
70
|
-
# a `STORAGE_OPTIMIZATION` task starts.
|
71
|
-
#
|
72
|
-
#
|
70
|
+
# a `STORAGE_OPTIMIZATION` task starts.
|
71
|
+
#
|
72
|
+
# * For Windows, storage optimization is the process of migrating
|
73
|
+
# the file system data to the new, larger disks.
|
74
|
+
#
|
75
|
+
# * For Lustre, storage optimization consists of rebalancing the
|
76
|
+
# data across the existing and newly added file servers.
|
77
|
+
#
|
78
|
+
# You can track the storage optimization progress using the
|
73
79
|
# `ProgressPercent` property. When `STORAGE_OPTIMIZATION` completes
|
74
80
|
# successfully, the parent `FILE_SYSTEM_UPDATE` action status
|
75
81
|
# changes to `COMPLETED`. For more information, see [Managing
|
76
|
-
#
|
82
|
+
# storage capacity][1] in the *Amazon FSx for Windows File Server
|
83
|
+
# User Guide* and [Managing storage and throughput capacity][2] in
|
84
|
+
# the *Amazon FSx for Lustre User Guide*.
|
85
|
+
#
|
86
|
+
# * `FILE_SYSTEM_ALIAS_ASSOCIATION` - A file system update to
|
87
|
+
# associate a new DNS alias with the file system. For more
|
88
|
+
# information, see .
|
89
|
+
#
|
90
|
+
# * `FILE_SYSTEM_ALIAS_DISASSOCIATION` - A file system update to
|
91
|
+
# disassociate a DNS alias from the file system. For more
|
92
|
+
# information, see .
|
77
93
|
#
|
78
94
|
#
|
79
95
|
#
|
80
96
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
|
97
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html
|
81
98
|
# @return [String]
|
82
99
|
#
|
83
100
|
# @!attribute [rw] progress_percent
|
84
101
|
# Provides the percent complete of a `STORAGE_OPTIMIZATION`
|
85
|
-
# administrative action.
|
102
|
+
# administrative action. Does not apply to any other administrative
|
103
|
+
# action type.
|
86
104
|
# @return [Integer]
|
87
105
|
#
|
88
106
|
# @!attribute [rw] request_time
|
@@ -107,16 +125,20 @@ module Aws::FSx
|
|
107
125
|
# * `UPDATED_OPTIMIZING` - For a storage capacity increase update,
|
108
126
|
# Amazon FSx has updated the file system with the new storage
|
109
127
|
# capacity, and is now performing the storage optimization process.
|
110
|
-
# For more information, see [Managing
|
128
|
+
# For more information, see [Managing storage capacity][1] in the
|
129
|
+
# *Amazon FSx for Windows File Server User Guide* and [Managing
|
130
|
+
# storage and throughput capacity][2] in the *Amazon FSx for Lustre
|
131
|
+
# User Guide*.
|
111
132
|
#
|
112
133
|
#
|
113
134
|
#
|
114
135
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
|
136
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html
|
115
137
|
# @return [String]
|
116
138
|
#
|
117
139
|
# @!attribute [rw] target_file_system_values
|
118
|
-
# Describes the target
|
119
|
-
#
|
140
|
+
# Describes the target value for the administration action, provided
|
141
|
+
# in the `UpdateFileSystem` operation. Returned for
|
120
142
|
# `FILE_SYSTEM_UPDATE` administrative actions.
|
121
143
|
# @return [Types::FileSystem]
|
122
144
|
#
|
@@ -140,7 +162,8 @@ module Aws::FSx
|
|
140
162
|
# Provides information about a failed administrative action.
|
141
163
|
#
|
142
164
|
# @!attribute [rw] message
|
143
|
-
# Error message providing details about the
|
165
|
+
# Error message providing details about the failed administrative
|
166
|
+
# action.
|
144
167
|
# @return [String]
|
145
168
|
#
|
146
169
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AdministrativeActionFailureDetails AWS API Documentation
|
@@ -151,7 +174,150 @@ module Aws::FSx
|
|
151
174
|
include Aws::Structure
|
152
175
|
end
|
153
176
|
|
154
|
-
# A
|
177
|
+
# A DNS alias that is associated with the file system. You can use a DNS
|
178
|
+
# alias to access a file system using user-defined DNS names, in
|
179
|
+
# addition to the default DNS name that Amazon FSx assigns to the file
|
180
|
+
# system. For more information, see [DNS aliases][1] in the *FSx for
|
181
|
+
# Windows File Server User Guide*.
|
182
|
+
#
|
183
|
+
#
|
184
|
+
#
|
185
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html
|
186
|
+
#
|
187
|
+
# @!attribute [rw] name
|
188
|
+
# The name of the DNS alias. The alias name has to meet the following
|
189
|
+
# requirements:
|
190
|
+
#
|
191
|
+
# * Formatted as a fully-qualified domain name (FQDN),
|
192
|
+
# `hostname.domain`, for example, `accounting.example.com`.
|
193
|
+
#
|
194
|
+
# * Can contain alphanumeric characters and the hyphen (-).
|
195
|
+
#
|
196
|
+
# * Cannot start or end with a hyphen.
|
197
|
+
#
|
198
|
+
# * Can start with a numeric.
|
199
|
+
#
|
200
|
+
# For DNS names, Amazon FSx stores alphabetic characters as lowercase
|
201
|
+
# letters (a-z), regardless of how you specify them: as uppercase
|
202
|
+
# letters, lowercase letters, or the corresponding letters in escape
|
203
|
+
# codes.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @!attribute [rw] lifecycle
|
207
|
+
# Describes the state of the DNS alias.
|
208
|
+
#
|
209
|
+
# * AVAILABLE - The DNS alias is associated with an Amazon FSx file
|
210
|
+
# system.
|
211
|
+
#
|
212
|
+
# * CREATING - Amazon FSx is creating the DNS alias and associating it
|
213
|
+
# with the file system.
|
214
|
+
#
|
215
|
+
# * CREATE\_FAILED - Amazon FSx was unable to associate the DNS alias
|
216
|
+
# with the file system.
|
217
|
+
#
|
218
|
+
# * DELETING - Amazon FSx is disassociating the DNS alias from the
|
219
|
+
# file system and deleting it.
|
220
|
+
#
|
221
|
+
# * DELETE\_FAILED - Amazon FSx was unable to disassocate the DNS
|
222
|
+
# alias from the file system.
|
223
|
+
# @return [String]
|
224
|
+
#
|
225
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/Alias AWS API Documentation
|
226
|
+
#
|
227
|
+
class Alias < Struct.new(
|
228
|
+
:name,
|
229
|
+
:lifecycle)
|
230
|
+
SENSITIVE = []
|
231
|
+
include Aws::Structure
|
232
|
+
end
|
233
|
+
|
234
|
+
# The request object specifying one or more DNS alias names to associate
|
235
|
+
# with an Amazon FSx for Windows File Server file system.
|
236
|
+
#
|
237
|
+
# @note When making an API call, you may pass AssociateFileSystemAliasesRequest
|
238
|
+
# data as a hash:
|
239
|
+
#
|
240
|
+
# {
|
241
|
+
# client_request_token: "ClientRequestToken",
|
242
|
+
# file_system_id: "FileSystemId", # required
|
243
|
+
# aliases: ["AlternateDNSName"], # required
|
244
|
+
# }
|
245
|
+
#
|
246
|
+
# @!attribute [rw] client_request_token
|
247
|
+
# (Optional) An idempotency token for resource creation, in a string
|
248
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
249
|
+
# your behalf when you use the AWS Command Line Interface (AWS CLI) or
|
250
|
+
# an AWS SDK.
|
251
|
+
#
|
252
|
+
# **A suitable default value is auto-generated.** You should normally
|
253
|
+
# not need to pass this option.
|
254
|
+
# @return [String]
|
255
|
+
#
|
256
|
+
# @!attribute [rw] file_system_id
|
257
|
+
# Specifies the file system with which you want to associate one or
|
258
|
+
# more DNS aliases.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] aliases
|
262
|
+
# An array of one or more DNS alias names to associate with the file
|
263
|
+
# system. The alias name has to comply with the following formatting
|
264
|
+
# requirements:
|
265
|
+
#
|
266
|
+
# * Formatted as a fully-qualified domain name (FQDN), <i>
|
267
|
+
# <code>hostname.domain</code> </i>, for example,
|
268
|
+
# `accounting.corp.example.com`.
|
269
|
+
#
|
270
|
+
# * Can contain alphanumeric characters and the hyphen (-).
|
271
|
+
#
|
272
|
+
# * Cannot start or end with a hyphen.
|
273
|
+
#
|
274
|
+
# * Can start with a numeric.
|
275
|
+
#
|
276
|
+
# For DNS alias names, Amazon FSx stores alphabetic characters as
|
277
|
+
# lowercase letters (a-z), regardless of how you specify them: as
|
278
|
+
# uppercase letters, lowercase letters, or the corresponding letters
|
279
|
+
# in escape codes.
|
280
|
+
# @return [Array<String>]
|
281
|
+
#
|
282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AssociateFileSystemAliasesRequest AWS API Documentation
|
283
|
+
#
|
284
|
+
class AssociateFileSystemAliasesRequest < Struct.new(
|
285
|
+
:client_request_token,
|
286
|
+
:file_system_id,
|
287
|
+
:aliases)
|
288
|
+
SENSITIVE = []
|
289
|
+
include Aws::Structure
|
290
|
+
end
|
291
|
+
|
292
|
+
# The system generated response showing the DNS aliases that Amazon FSx
|
293
|
+
# is attempting to associate with the file system. Use the API operation
|
294
|
+
# to monitor the status of the aliases Amazon FSx is associating with
|
295
|
+
# the file system. It can take up to 2.5 minutes for the alias status to
|
296
|
+
# change from `CREATING` to `AVAILABLE`.
|
297
|
+
#
|
298
|
+
# @!attribute [rw] aliases
|
299
|
+
# An array of the DNS aliases that Amazon FSx is associating with the
|
300
|
+
# file system.
|
301
|
+
# @return [Array<Types::Alias>]
|
302
|
+
#
|
303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AssociateFileSystemAliasesResponse AWS API Documentation
|
304
|
+
#
|
305
|
+
class AssociateFileSystemAliasesResponse < Struct.new(
|
306
|
+
:aliases)
|
307
|
+
SENSITIVE = []
|
308
|
+
include Aws::Structure
|
309
|
+
end
|
310
|
+
|
311
|
+
# A backup of an Amazon FSx file system. For more information see:
|
312
|
+
#
|
313
|
+
# * [Working with backups for Windows file systems][1]
|
314
|
+
#
|
315
|
+
# * [Working with backups for Lustre file systems][2]
|
316
|
+
#
|
317
|
+
#
|
318
|
+
#
|
319
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html
|
320
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html
|
155
321
|
#
|
156
322
|
# @!attribute [rw] backup_id
|
157
323
|
# The ID of the backup.
|
@@ -159,6 +325,21 @@ module Aws::FSx
|
|
159
325
|
#
|
160
326
|
# @!attribute [rw] lifecycle
|
161
327
|
# The lifecycle status of the backup.
|
328
|
+
#
|
329
|
+
# * `AVAILABLE` - The backup is fully available.
|
330
|
+
#
|
331
|
+
# * `PENDING` - For user-initiated backups on Lustre file systems
|
332
|
+
# only; Amazon FSx has not started creating the backup.
|
333
|
+
#
|
334
|
+
# * `CREATING` - Amazon FSx is creating the backup.
|
335
|
+
#
|
336
|
+
# * `TRANSFERRING` - For user-initiated backups on Lustre file systems
|
337
|
+
# only; Amazon FSx is transferring the backup to S3.
|
338
|
+
#
|
339
|
+
# * `DELETED` - Amazon FSx deleted the backup and it is no longer
|
340
|
+
# available.
|
341
|
+
#
|
342
|
+
# * `FAILED` - Amazon FSx could not complete the backup.
|
162
343
|
# @return [String]
|
163
344
|
#
|
164
345
|
# @!attribute [rw] failure_details
|
@@ -179,8 +360,7 @@ module Aws::FSx
|
|
179
360
|
#
|
180
361
|
# @!attribute [rw] kms_key_id
|
181
362
|
# The ID of the AWS Key Management Service (AWS KMS) key used to
|
182
|
-
# encrypt
|
183
|
-
# data at rest. Amazon FSx for Lustre does not support KMS encryption.
|
363
|
+
# encrypt the backup of the Amazon FSx file system's data at rest.
|
184
364
|
# @return [String]
|
185
365
|
#
|
186
366
|
# @!attribute [rw] resource_arn
|
@@ -434,21 +614,21 @@ module Aws::FSx
|
|
434
614
|
# @return [String]
|
435
615
|
#
|
436
616
|
# @!attribute [rw] client_request_token
|
437
|
-
# A string of up to 64 ASCII characters that Amazon FSx
|
438
|
-
# idempotent creation. This string is automatically
|
439
|
-
# behalf when you use the AWS Command Line Interface
|
440
|
-
# AWS SDK.
|
617
|
+
# (Optional) A string of up to 64 ASCII characters that Amazon FSx
|
618
|
+
# uses to ensure idempotent creation. This string is automatically
|
619
|
+
# filled on your behalf when you use the AWS Command Line Interface
|
620
|
+
# (AWS CLI) or an AWS SDK.
|
441
621
|
#
|
442
622
|
# **A suitable default value is auto-generated.** You should normally
|
443
623
|
# not need to pass this option.
|
444
624
|
# @return [String]
|
445
625
|
#
|
446
626
|
# @!attribute [rw] tags
|
447
|
-
# The tags to apply to the backup at backup creation. The
|
448
|
-
# the `Name` tag appears in the console as the backup
|
449
|
-
# have set `CopyTagsToBackups` to true, and you specify
|
450
|
-
# tags using the `CreateBackup` action, no existing
|
451
|
-
# system are copied from the file system to the backup.
|
627
|
+
# (Optional) The tags to apply to the backup at backup creation. The
|
628
|
+
# key value of the `Name` tag appears in the console as the backup
|
629
|
+
# name. If you have set `CopyTagsToBackups` to true, and you specify
|
630
|
+
# one or more tags using the `CreateBackup` action, no existing file
|
631
|
+
# system tags are copied from the file system to the backup.
|
452
632
|
# @return [Array<Types::Tag>]
|
453
633
|
#
|
454
634
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackupRequest AWS API Documentation
|
@@ -599,6 +779,7 @@ module Aws::FSx
|
|
599
779
|
# daily_automatic_backup_start_time: "DailyTime",
|
600
780
|
# automatic_backup_retention_days: 1,
|
601
781
|
# copy_tags_to_backups: false,
|
782
|
+
# aliases: ["AlternateDNSName"],
|
602
783
|
# },
|
603
784
|
# lustre_configuration: {
|
604
785
|
# weekly_maintenance_start_time: "WeeklyTime",
|
@@ -737,9 +918,10 @@ module Aws::FSx
|
|
737
918
|
# }
|
738
919
|
#
|
739
920
|
# @!attribute [rw] weekly_maintenance_start_time
|
740
|
-
# The preferred start time to perform weekly maintenance,
|
741
|
-
# d:HH:MM in the UTC time zone, where d is the weekday
|
742
|
-
# through 7, beginning with Monday and ending with
|
921
|
+
# (Optional) The preferred start time to perform weekly maintenance,
|
922
|
+
# formatted d:HH:MM in the UTC time zone, where d is the weekday
|
923
|
+
# number, from 1 through 7, beginning with Monday and ending with
|
924
|
+
# Sunday.
|
743
925
|
# @return [String]
|
744
926
|
#
|
745
927
|
# @!attribute [rw] import_path
|
@@ -813,27 +995,25 @@ module Aws::FSx
|
|
813
995
|
# @return [String]
|
814
996
|
#
|
815
997
|
# @!attribute [rw] auto_import_policy
|
816
|
-
# (Optional)
|
817
|
-
#
|
818
|
-
#
|
819
|
-
#
|
820
|
-
#
|
821
|
-
#
|
822
|
-
# * `NONE` - (Default) AutoImport is off.
|
823
|
-
#
|
824
|
-
#
|
825
|
-
#
|
826
|
-
#
|
827
|
-
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
#
|
831
|
-
# * `NEW_CHANGED` - AutoImport is on.
|
832
|
-
#
|
833
|
-
#
|
834
|
-
#
|
835
|
-
# system. Files deleted from the linked data repository are not
|
836
|
-
# deleted from the FSx file system.
|
998
|
+
# (Optional) When you create your file system, your existing S3
|
999
|
+
# objects appear as file and directory listings. Use this property to
|
1000
|
+
# choose how Amazon FSx keeps your file and directory listings up to
|
1001
|
+
# date as you add or modify objects in your linked S3 bucket.
|
1002
|
+
# `AutoImportPolicy` can have the following values:
|
1003
|
+
#
|
1004
|
+
# * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file
|
1005
|
+
# and directory listings from the linked S3 bucket when the file
|
1006
|
+
# system is created. FSx does not update file and directory listings
|
1007
|
+
# for any new or changed objects after choosing this option.
|
1008
|
+
#
|
1009
|
+
# * `NEW` - AutoImport is on. Amazon FSx automatically imports
|
1010
|
+
# directory listings of any new objects added to the linked S3
|
1011
|
+
# bucket that do not currently exist in the FSx file system.
|
1012
|
+
#
|
1013
|
+
# * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports
|
1014
|
+
# file and directory listings of any new objects added to the S3
|
1015
|
+
# bucket and any existing objects that are changed in the S3 bucket
|
1016
|
+
# after you choose this option.
|
837
1017
|
#
|
838
1018
|
# For more information, see [Automatically import updates from your S3
|
839
1019
|
# bucket][1].
|
@@ -849,7 +1029,7 @@ module Aws::FSx
|
|
849
1029
|
# in MB/s/TiB. File system throughput capacity is calculated by
|
850
1030
|
# multiplying file system storage capacity (TiB) by the
|
851
1031
|
# PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system,
|
852
|
-
# provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields
|
1032
|
+
# provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s
|
853
1033
|
# of file system throughput. You pay for the amount of throughput that
|
854
1034
|
# you provision.
|
855
1035
|
#
|
@@ -870,14 +1050,16 @@ module Aws::FSx
|
|
870
1050
|
# @return [Integer]
|
871
1051
|
#
|
872
1052
|
# @!attribute [rw] copy_tags_to_backups
|
873
|
-
#
|
874
|
-
#
|
875
|
-
#
|
876
|
-
#
|
877
|
-
#
|
878
|
-
# tags
|
879
|
-
#
|
880
|
-
#
|
1053
|
+
# (Optional) Not available to use with file systems that are linked to
|
1054
|
+
# a data repository. A boolean flag indicating whether tags for the
|
1055
|
+
# file system should be copied to backups. The default value is false.
|
1056
|
+
# If it's set to true, all file system tags are copied to all
|
1057
|
+
# automatic and user-initiated backups when the user doesn't specify
|
1058
|
+
# any backup-specific tags. If this value is true, and you specify one
|
1059
|
+
# or more backup tags, only the specified tags are copied to backups.
|
1060
|
+
# If you specify one or more tags when creating a user-initiated
|
1061
|
+
# backup, no tags are copied from the file system, regardless of this
|
1062
|
+
# value.
|
881
1063
|
#
|
882
1064
|
# For more information, see [Working with backups][1].
|
883
1065
|
#
|
@@ -950,6 +1132,7 @@ module Aws::FSx
|
|
950
1132
|
# daily_automatic_backup_start_time: "DailyTime",
|
951
1133
|
# automatic_backup_retention_days: 1,
|
952
1134
|
# copy_tags_to_backups: false,
|
1135
|
+
# aliases: ["AlternateDNSName"],
|
953
1136
|
# },
|
954
1137
|
# lustre_configuration: {
|
955
1138
|
# weekly_maintenance_start_time: "WeeklyTime",
|
@@ -986,11 +1169,15 @@ module Aws::FSx
|
|
986
1169
|
#
|
987
1170
|
# For Lustre file systems:
|
988
1171
|
#
|
989
|
-
# * For `SCRATCH_2` and `PERSISTENT_1` deployment types, valid
|
990
|
-
# are
|
1172
|
+
# * For `SCRATCH_2` and `PERSISTENT_1 SSD` deployment types, valid
|
1173
|
+
# values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.
|
991
1174
|
#
|
992
|
-
# * For `
|
993
|
-
# increments of
|
1175
|
+
# * For `PERSISTENT HDD` file systems, valid values are increments of
|
1176
|
+
# 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB
|
1177
|
+
# for 40 MB/s/TiB file systems.
|
1178
|
+
#
|
1179
|
+
# * For `SCRATCH_1` deployment type, valid values are 1200 GiB, 2400
|
1180
|
+
# GiB, and increments of 3600 GiB.
|
994
1181
|
#
|
995
1182
|
# For Windows file systems:
|
996
1183
|
#
|
@@ -1002,22 +1189,24 @@ module Aws::FSx
|
|
1002
1189
|
# @return [Integer]
|
1003
1190
|
#
|
1004
1191
|
# @!attribute [rw] storage_type
|
1005
|
-
# Sets the storage type for the
|
1006
|
-
#
|
1192
|
+
# Sets the storage type for the file system you're creating. Valid
|
1193
|
+
# values are `SSD` and `HDD`.
|
1007
1194
|
#
|
1008
1195
|
# * Set to `SSD` to use solid state drive storage. SSD is supported on
|
1009
|
-
# all Windows deployment types.
|
1196
|
+
# all Windows and Lustre deployment types.
|
1010
1197
|
#
|
1011
1198
|
# * Set to `HDD` to use hard disk drive storage. HDD is supported on
|
1012
1199
|
# `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment
|
1013
|
-
# types.
|
1200
|
+
# types, and on `PERSISTENT` Lustre file system deployment types.
|
1014
1201
|
#
|
1015
1202
|
# Default value is `SSD`. For more information, see [ Storage Type
|
1016
|
-
# Options][1] in the *Amazon FSx for Windows User Guide
|
1203
|
+
# Options][1] in the *Amazon FSx for Windows User Guide* and [Multiple
|
1204
|
+
# Storage Options][2] in the *Amazon FSx for Lustre User Guide*.
|
1017
1205
|
#
|
1018
1206
|
#
|
1019
1207
|
#
|
1020
1208
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options
|
1209
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/what-is.html#storage-options
|
1021
1210
|
# @return [String]
|
1022
1211
|
#
|
1023
1212
|
# @!attribute [rw] subnet_ids
|
@@ -1122,6 +1311,7 @@ module Aws::FSx
|
|
1122
1311
|
# daily_automatic_backup_start_time: "DailyTime",
|
1123
1312
|
# automatic_backup_retention_days: 1,
|
1124
1313
|
# copy_tags_to_backups: false,
|
1314
|
+
# aliases: ["AlternateDNSName"],
|
1125
1315
|
# }
|
1126
1316
|
#
|
1127
1317
|
# @!attribute [rw] active_directory_id
|
@@ -1204,6 +1394,44 @@ module Aws::FSx
|
|
1204
1394
|
# system, regardless of this value.
|
1205
1395
|
# @return [Boolean]
|
1206
1396
|
#
|
1397
|
+
# @!attribute [rw] aliases
|
1398
|
+
# An array of one or more DNS alias names that you want to associate
|
1399
|
+
# with the Amazon FSx file system. Aliases allow you to use existing
|
1400
|
+
# DNS names to access the data in your Amazon FSx file system. You can
|
1401
|
+
# associate up to 50 aliases with a file system at any time. You can
|
1402
|
+
# associate additional DNS aliases after you create the file system
|
1403
|
+
# using the AssociateFileSystemAliases operation. You can remove DNS
|
1404
|
+
# aliases from the file system after it is created using the
|
1405
|
+
# DisassociateFileSystemAliases operation. You only need to specify
|
1406
|
+
# the alias name in the request payload.
|
1407
|
+
#
|
1408
|
+
# For more information, see [Working with DNS Aliases][1] and
|
1409
|
+
# [Walkthrough 5: Using DNS aliases to access your file system][2],
|
1410
|
+
# including additional steps you must take to be able to access your
|
1411
|
+
# file system using a DNS alias.
|
1412
|
+
#
|
1413
|
+
# An alias name has to meet the following requirements:
|
1414
|
+
#
|
1415
|
+
# * Formatted as a fully-qualified domain name (FQDN),
|
1416
|
+
# `hostname.domain`, for example, `accounting.example.com`.
|
1417
|
+
#
|
1418
|
+
# * Can contain alphanumeric characters and the hyphen (-).
|
1419
|
+
#
|
1420
|
+
# * Cannot start or end with a hyphen.
|
1421
|
+
#
|
1422
|
+
# * Can start with a numeric.
|
1423
|
+
#
|
1424
|
+
# For DNS alias names, Amazon FSx stores alphabetic characters as
|
1425
|
+
# lowercase letters (a-z), regardless of how you specify them: as
|
1426
|
+
# uppercase letters, lowercase letters, or the corresponding letters
|
1427
|
+
# in escape codes.
|
1428
|
+
#
|
1429
|
+
#
|
1430
|
+
#
|
1431
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html
|
1432
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/walkthrough05-file-system-custom-CNAME.html
|
1433
|
+
# @return [Array<String>]
|
1434
|
+
#
|
1207
1435
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemWindowsConfiguration AWS API Documentation
|
1208
1436
|
#
|
1209
1437
|
class CreateFileSystemWindowsConfiguration < Struct.new(
|
@@ -1215,7 +1443,8 @@ module Aws::FSx
|
|
1215
1443
|
:weekly_maintenance_start_time,
|
1216
1444
|
:daily_automatic_backup_start_time,
|
1217
1445
|
:automatic_backup_retention_days,
|
1218
|
-
:copy_tags_to_backups
|
1446
|
+
:copy_tags_to_backups,
|
1447
|
+
:aliases)
|
1219
1448
|
SENSITIVE = []
|
1220
1449
|
include Aws::Structure
|
1221
1450
|
end
|
@@ -1274,26 +1503,24 @@ module Aws::FSx
|
|
1274
1503
|
#
|
1275
1504
|
# @!attribute [rw] auto_import_policy
|
1276
1505
|
# Describes the file system's linked S3 data repository's
|
1277
|
-
# `AutoImportPolicy`. The AutoImportPolicy configures how
|
1278
|
-
#
|
1279
|
-
#
|
1280
|
-
#
|
1281
|
-
#
|
1282
|
-
# * `NONE` - (Default) AutoImport is off.
|
1283
|
-
#
|
1284
|
-
#
|
1285
|
-
#
|
1286
|
-
#
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
# * `NEW_CHANGED` - AutoImport is on.
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
#
|
1295
|
-
# system. Files deleted from the linked data repository are not
|
1296
|
-
# deleted from the FSx file system.
|
1506
|
+
# `AutoImportPolicy`. The AutoImportPolicy configures how Amazon FSx
|
1507
|
+
# keeps your file and directory listings up to date as you add or
|
1508
|
+
# modify objects in your linked S3 bucket. `AutoImportPolicy` can have
|
1509
|
+
# the following values:
|
1510
|
+
#
|
1511
|
+
# * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file
|
1512
|
+
# and directory listings from the linked S3 bucket when the file
|
1513
|
+
# system is created. FSx does not update file and directory listings
|
1514
|
+
# for any new or changed objects after choosing this option.
|
1515
|
+
#
|
1516
|
+
# * `NEW` - AutoImport is on. Amazon FSx automatically imports
|
1517
|
+
# directory listings of any new objects added to the linked S3
|
1518
|
+
# bucket that do not currently exist in the FSx file system.
|
1519
|
+
#
|
1520
|
+
# * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports
|
1521
|
+
# file and directory listings of any new objects added to the S3
|
1522
|
+
# bucket and any existing objects that are changed in the S3 bucket
|
1523
|
+
# after you choose this option.
|
1297
1524
|
#
|
1298
1525
|
# For more information, see [Automatically import updates from your S3
|
1299
1526
|
# bucket][1].
|
@@ -2002,6 +2229,81 @@ module Aws::FSx
|
|
2002
2229
|
include Aws::Structure
|
2003
2230
|
end
|
2004
2231
|
|
2232
|
+
# The request object for `DescribeFileSystemAliases` operation.
|
2233
|
+
#
|
2234
|
+
# @note When making an API call, you may pass DescribeFileSystemAliasesRequest
|
2235
|
+
# data as a hash:
|
2236
|
+
#
|
2237
|
+
# {
|
2238
|
+
# client_request_token: "ClientRequestToken",
|
2239
|
+
# file_system_id: "FileSystemId", # required
|
2240
|
+
# max_results: 1,
|
2241
|
+
# next_token: "NextToken",
|
2242
|
+
# }
|
2243
|
+
#
|
2244
|
+
# @!attribute [rw] client_request_token
|
2245
|
+
# (Optional) An idempotency token for resource creation, in a string
|
2246
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
2247
|
+
# your behalf when you use the AWS Command Line Interface (AWS CLI) or
|
2248
|
+
# an AWS SDK.
|
2249
|
+
#
|
2250
|
+
# **A suitable default value is auto-generated.** You should normally
|
2251
|
+
# not need to pass this option.
|
2252
|
+
# @return [String]
|
2253
|
+
#
|
2254
|
+
# @!attribute [rw] file_system_id
|
2255
|
+
# The ID of the file system to return the associated DNS aliases for
|
2256
|
+
# (String).
|
2257
|
+
# @return [String]
|
2258
|
+
#
|
2259
|
+
# @!attribute [rw] max_results
|
2260
|
+
# Maximum number of DNS aliases to return in the response (integer).
|
2261
|
+
# This parameter value must be greater than 0. The number of items
|
2262
|
+
# that Amazon FSx returns is the minimum of the `MaxResults` parameter
|
2263
|
+
# specified in the request and the service's internal maximum number
|
2264
|
+
# of items per page.
|
2265
|
+
# @return [Integer]
|
2266
|
+
#
|
2267
|
+
# @!attribute [rw] next_token
|
2268
|
+
# Opaque pagination token returned from a previous
|
2269
|
+
# `DescribeFileSystemAliases` operation (String). If a token is
|
2270
|
+
# included in the request, the action continues the list from where
|
2271
|
+
# the previous returning call left off.
|
2272
|
+
# @return [String]
|
2273
|
+
#
|
2274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemAliasesRequest AWS API Documentation
|
2275
|
+
#
|
2276
|
+
class DescribeFileSystemAliasesRequest < Struct.new(
|
2277
|
+
:client_request_token,
|
2278
|
+
:file_system_id,
|
2279
|
+
:max_results,
|
2280
|
+
:next_token)
|
2281
|
+
SENSITIVE = []
|
2282
|
+
include Aws::Structure
|
2283
|
+
end
|
2284
|
+
|
2285
|
+
# The response object for `DescribeFileSystemAliases` operation.
|
2286
|
+
#
|
2287
|
+
# @!attribute [rw] aliases
|
2288
|
+
# An array of one or more DNS aliases currently associated with the
|
2289
|
+
# specified file system.
|
2290
|
+
# @return [Array<Types::Alias>]
|
2291
|
+
#
|
2292
|
+
# @!attribute [rw] next_token
|
2293
|
+
# Present if there are more DNS aliases than returned in the response
|
2294
|
+
# (String). You can use the `NextToken` value in a later request to
|
2295
|
+
# fetch additional descriptions.
|
2296
|
+
# @return [String]
|
2297
|
+
#
|
2298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystemAliasesResponse AWS API Documentation
|
2299
|
+
#
|
2300
|
+
class DescribeFileSystemAliasesResponse < Struct.new(
|
2301
|
+
:aliases,
|
2302
|
+
:next_token)
|
2303
|
+
SENSITIVE = []
|
2304
|
+
include Aws::Structure
|
2305
|
+
end
|
2306
|
+
|
2005
2307
|
# The request object for `DescribeFileSystems` operation.
|
2006
2308
|
#
|
2007
2309
|
# @note When making an API call, you may pass DescribeFileSystemsRequest
|
@@ -2063,6 +2365,66 @@ module Aws::FSx
|
|
2063
2365
|
include Aws::Structure
|
2064
2366
|
end
|
2065
2367
|
|
2368
|
+
# The request object of DNS aliases to disassociate from an Amazon FSx
|
2369
|
+
# for Windows File Server file system.
|
2370
|
+
#
|
2371
|
+
# @note When making an API call, you may pass DisassociateFileSystemAliasesRequest
|
2372
|
+
# data as a hash:
|
2373
|
+
#
|
2374
|
+
# {
|
2375
|
+
# client_request_token: "ClientRequestToken",
|
2376
|
+
# file_system_id: "FileSystemId", # required
|
2377
|
+
# aliases: ["AlternateDNSName"], # required
|
2378
|
+
# }
|
2379
|
+
#
|
2380
|
+
# @!attribute [rw] client_request_token
|
2381
|
+
# (Optional) An idempotency token for resource creation, in a string
|
2382
|
+
# of up to 64 ASCII characters. This token is automatically filled on
|
2383
|
+
# your behalf when you use the AWS Command Line Interface (AWS CLI) or
|
2384
|
+
# an AWS SDK.
|
2385
|
+
#
|
2386
|
+
# **A suitable default value is auto-generated.** You should normally
|
2387
|
+
# not need to pass this option.
|
2388
|
+
# @return [String]
|
2389
|
+
#
|
2390
|
+
# @!attribute [rw] file_system_id
|
2391
|
+
# Specifies the file system from which to disassociate the DNS
|
2392
|
+
# aliases.
|
2393
|
+
# @return [String]
|
2394
|
+
#
|
2395
|
+
# @!attribute [rw] aliases
|
2396
|
+
# An array of one or more DNS alias names to disassociate, or remove,
|
2397
|
+
# from the file system.
|
2398
|
+
# @return [Array<String>]
|
2399
|
+
#
|
2400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DisassociateFileSystemAliasesRequest AWS API Documentation
|
2401
|
+
#
|
2402
|
+
class DisassociateFileSystemAliasesRequest < Struct.new(
|
2403
|
+
:client_request_token,
|
2404
|
+
:file_system_id,
|
2405
|
+
:aliases)
|
2406
|
+
SENSITIVE = []
|
2407
|
+
include Aws::Structure
|
2408
|
+
end
|
2409
|
+
|
2410
|
+
# The system generated response showing the DNS aliases that Amazon FSx
|
2411
|
+
# is attempting to disassociate from the file system. Use the API
|
2412
|
+
# operation to monitor the status of the aliases Amazon FSx is removing
|
2413
|
+
# from the file system.
|
2414
|
+
#
|
2415
|
+
# @!attribute [rw] aliases
|
2416
|
+
# An array of one or more DNS aliases that Amazon FSx is attempting to
|
2417
|
+
# disassociate from the file system.
|
2418
|
+
# @return [Array<Types::Alias>]
|
2419
|
+
#
|
2420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DisassociateFileSystemAliasesResponse AWS API Documentation
|
2421
|
+
#
|
2422
|
+
class DisassociateFileSystemAliasesResponse < Struct.new(
|
2423
|
+
:aliases)
|
2424
|
+
SENSITIVE = []
|
2425
|
+
include Aws::Structure
|
2426
|
+
end
|
2427
|
+
|
2066
2428
|
# A description of a specific Amazon FSx file system.
|
2067
2429
|
#
|
2068
2430
|
# @!attribute [rw] owner_id
|
@@ -2112,7 +2474,7 @@ module Aws::FSx
|
|
2112
2474
|
# @return [Types::FileSystemFailureDetails]
|
2113
2475
|
#
|
2114
2476
|
# @!attribute [rw] storage_capacity
|
2115
|
-
# The storage capacity of the file system in
|
2477
|
+
# The storage capacity of the file system in gibibytes (GiB).
|
2116
2478
|
# @return [Integer]
|
2117
2479
|
#
|
2118
2480
|
# @!attribute [rw] storage_type
|
@@ -2973,9 +3335,9 @@ module Aws::FSx
|
|
2973
3335
|
# }
|
2974
3336
|
#
|
2975
3337
|
# @!attribute [rw] weekly_maintenance_start_time
|
2976
|
-
# The preferred start time to perform weekly maintenance,
|
2977
|
-
# d:HH:MM in the UTC time zone. d is the weekday number,
|
2978
|
-
# through 7, beginning with Monday and ending with Sunday.
|
3338
|
+
# (Optional) The preferred start time to perform weekly maintenance,
|
3339
|
+
# formatted d:HH:MM in the UTC time zone. d is the weekday number,
|
3340
|
+
# from 1 through 7, beginning with Monday and ending with Sunday.
|
2979
3341
|
# @return [String]
|
2980
3342
|
#
|
2981
3343
|
# @!attribute [rw] daily_automatic_backup_start_time
|
@@ -2991,27 +3353,25 @@ module Aws::FSx
|
|
2991
3353
|
# @return [Integer]
|
2992
3354
|
#
|
2993
3355
|
# @!attribute [rw] auto_import_policy
|
2994
|
-
# (Optional)
|
2995
|
-
#
|
2996
|
-
#
|
2997
|
-
#
|
2998
|
-
#
|
2999
|
-
#
|
3000
|
-
# * `NONE` - (Default) AutoImport is off.
|
3001
|
-
#
|
3002
|
-
#
|
3003
|
-
#
|
3004
|
-
#
|
3005
|
-
#
|
3006
|
-
#
|
3007
|
-
#
|
3008
|
-
#
|
3009
|
-
# * `NEW_CHANGED` - AutoImport is on.
|
3010
|
-
#
|
3011
|
-
#
|
3012
|
-
#
|
3013
|
-
# system. Files deleted from the linked data repository are not
|
3014
|
-
# deleted from the FSx file system.
|
3356
|
+
# (Optional) When you create your file system, your existing S3
|
3357
|
+
# objects appear as file and directory listings. Use this property to
|
3358
|
+
# choose how Amazon FSx keeps your file and directory listing up to
|
3359
|
+
# date as you add or modify objects in your linked S3 bucket.
|
3360
|
+
# `AutoImportPolicy` can have the following values:
|
3361
|
+
#
|
3362
|
+
# * `NONE` - (Default) AutoImport is off. Amazon FSx only updates file
|
3363
|
+
# and directory listings from the linked S3 bucket when the file
|
3364
|
+
# system is created. FSx does not update the file and directory
|
3365
|
+
# listing for any new or changed objects after choosing this option.
|
3366
|
+
#
|
3367
|
+
# * `NEW` - AutoImport is on. Amazon FSx automatically imports
|
3368
|
+
# directory listings of any new objects added to the linked S3
|
3369
|
+
# bucket that do not currently exist in the FSx file system.
|
3370
|
+
#
|
3371
|
+
# * `NEW_CHANGED` - AutoImport is on. Amazon FSx automatically imports
|
3372
|
+
# file and directory listings of any new objects added to the S3
|
3373
|
+
# bucket and any existing objects that are changed in the S3 bucket
|
3374
|
+
# after you choose this option.
|
3015
3375
|
#
|
3016
3376
|
# For more information, see [Automatically import updates from your S3
|
3017
3377
|
# bucket][1].
|
@@ -3076,18 +3436,40 @@ module Aws::FSx
|
|
3076
3436
|
#
|
3077
3437
|
# @!attribute [rw] storage_capacity
|
3078
3438
|
# Use this parameter to increase the storage capacity of an Amazon FSx
|
3079
|
-
#
|
3080
|
-
#
|
3081
|
-
#
|
3082
|
-
#
|
3083
|
-
#
|
3084
|
-
#
|
3085
|
-
#
|
3086
|
-
#
|
3439
|
+
# file system. Specifies the storage capacity target value, GiB, to
|
3440
|
+
# increase the storage capacity for the file system that you're
|
3441
|
+
# updating. You cannot make a storage capacity increase request if
|
3442
|
+
# there is an existing storage capacity increase request in progress.
|
3443
|
+
#
|
3444
|
+
# For Windows file systems, the storage capacity target value must be
|
3445
|
+
# at least 10 percent (%) greater than the current storage capacity
|
3446
|
+
# value. In order to increase storage capacity, the file system must
|
3447
|
+
# have at least 16 MB/s of throughput capacity.
|
3448
|
+
#
|
3449
|
+
# For Lustre file systems, the storage capacity target value can be
|
3450
|
+
# the following:
|
3451
|
+
#
|
3452
|
+
# * For `SCRATCH_2` and `PERSISTENT_1 SSD` deployment types, valid
|
3453
|
+
# values are in multiples of 2400 GiB. The value must be greater
|
3454
|
+
# than the current storage capacity.
|
3455
|
+
#
|
3456
|
+
# * For `PERSISTENT HDD` file systems, valid values are multiples of
|
3457
|
+
# 6000 GiB for 12 MB/s/TiB file systems and multiples of 1800 GiB
|
3458
|
+
# for 40 MB/s/TiB file systems. The values must be greater than the
|
3459
|
+
# current storage capacity.
|
3460
|
+
#
|
3461
|
+
# * For `SCRATCH_1` file systems, you cannot increase the storage
|
3462
|
+
# capacity.
|
3463
|
+
#
|
3464
|
+
# For more information, see [Managing storage capacity][1] in the
|
3465
|
+
# *Amazon FSx for Windows File Server User Guide* and [Managing
|
3466
|
+
# storage and throughput capacity][2] in the *Amazon FSx for Lustre
|
3467
|
+
# User Guide*.
|
3087
3468
|
#
|
3088
3469
|
#
|
3089
3470
|
#
|
3090
3471
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
|
3472
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html
|
3091
3473
|
# @return [Integer]
|
3092
3474
|
#
|
3093
3475
|
# @!attribute [rw] windows_configuration
|
@@ -3318,6 +3700,23 @@ module Aws::FSx
|
|
3318
3700
|
# copied from the file system, regardless of this value.
|
3319
3701
|
# @return [Boolean]
|
3320
3702
|
#
|
3703
|
+
# @!attribute [rw] aliases
|
3704
|
+
# An array of one or more DNS aliases that are currently associated
|
3705
|
+
# with the Amazon FSx file system. Aliases allow you to use existing
|
3706
|
+
# DNS names to access the data in your Amazon FSx file system. You can
|
3707
|
+
# associate up to 50 aliases with a file system at any time. You can
|
3708
|
+
# associate additional DNS aliases after you create the file system
|
3709
|
+
# using the AssociateFileSystemAliases operation. You can remove DNS
|
3710
|
+
# aliases from the file system after it is created using the
|
3711
|
+
# DisassociateFileSystemAliases operation. You only need to specify
|
3712
|
+
# the alias name in the request payload. For more information, see
|
3713
|
+
# [DNS aliases][1].
|
3714
|
+
#
|
3715
|
+
#
|
3716
|
+
#
|
3717
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html
|
3718
|
+
# @return [Array<Types::Alias>]
|
3719
|
+
#
|
3321
3720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsFileSystemConfiguration AWS API Documentation
|
3322
3721
|
#
|
3323
3722
|
class WindowsFileSystemConfiguration < Struct.new(
|
@@ -3332,7 +3731,8 @@ module Aws::FSx
|
|
3332
3731
|
:weekly_maintenance_start_time,
|
3333
3732
|
:daily_automatic_backup_start_time,
|
3334
3733
|
:automatic_backup_retention_days,
|
3335
|
-
:copy_tags_to_backups
|
3734
|
+
:copy_tags_to_backups,
|
3735
|
+
:aliases)
|
3336
3736
|
SENSITIVE = []
|
3337
3737
|
include Aws::Structure
|
3338
3738
|
end
|