aws-sdk-fsx 1.16.0 → 1.21.1
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 +5 -5
- data/lib/aws-sdk-fsx.rb +1 -1
- data/lib/aws-sdk-fsx/client.rb +212 -59
- data/lib/aws-sdk-fsx/client_api.rb +28 -0
- data/lib/aws-sdk-fsx/resource.rb +1 -7
- data/lib/aws-sdk-fsx/types.rb +331 -80
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: efc143aaa96523642d57237fe420ab12bfa88a3465aa7a49b79fc49dc8b14a52
|
4
|
+
data.tar.gz: 71d78c8d26dae17cb40ced45ef024b38a0ece925c8067eeda0656786533b8985
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 81a5ea8c5d6699211ec7b28311518fa22c8ed772adfd7628d9b3d9247a9215da4b8c8809dc7962cb6407b1c44b47a90d054a504db8f781822d4fab005f2ba670
|
7
|
+
data.tar.gz: e5e5d1bd7df6733d14c11d30fe938525fbccd80acc593874eff4a8c38443ab697c74b9c5ccf7a2eea316a51e29465ee1e7da6cb4e6f9b88f3e44f337e0c00c70
|
data/lib/aws-sdk-fsx.rb
CHANGED
data/lib/aws-sdk-fsx/client.rb
CHANGED
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
30
|
|
@@ -32,11 +33,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:fsx)
|
|
32
33
|
module Aws::FSx
|
33
34
|
# An API client for FSx. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
35
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
36
|
+
# client = Aws::FSx::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
40
41
|
#
|
41
42
|
# For details on configuring region and credentials see
|
42
43
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -69,6 +70,7 @@ module Aws::FSx
|
|
69
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
75
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
74
76
|
|
@@ -105,7 +107,7 @@ module Aws::FSx
|
|
105
107
|
# @option options [required, String] :region
|
106
108
|
# The AWS region to connect to. The configured `:region` is
|
107
109
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
109
111
|
#
|
110
112
|
# * `Aws.config[:region]`
|
111
113
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +163,7 @@ module Aws::FSx
|
|
161
163
|
# @option options [String] :endpoint
|
162
164
|
# The client endpoint is normally constructed from the `:region`
|
163
165
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
167
|
#
|
166
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +178,7 @@ module Aws::FSx
|
|
176
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
179
|
#
|
178
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
182
|
#
|
181
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
184
|
# The log formatter.
|
@@ -229,15 +231,19 @@ module Aws::FSx
|
|
229
231
|
#
|
230
232
|
# @option options [String] :retry_mode ("legacy")
|
231
233
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
241
247
|
#
|
242
248
|
# @option options [String] :secret_access_key
|
243
249
|
#
|
@@ -275,8 +281,7 @@ module Aws::FSx
|
|
275
281
|
#
|
276
282
|
# @option options [Integer] :http_read_timeout (60) The default
|
277
283
|
# number of seconds to wait for response data. This value can
|
278
|
-
# safely be set
|
279
|
-
# per-request on the session yielded by {#session_for}.
|
284
|
+
# safely be set per-request on the session.
|
280
285
|
#
|
281
286
|
# @option options [Float] :http_idle_timeout (5) The number of
|
282
287
|
# seconds a connection is allowed to sit idle before it is
|
@@ -288,7 +293,7 @@ module Aws::FSx
|
|
288
293
|
# request body. This option has no effect unless the request has
|
289
294
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
290
295
|
# disables this behaviour. This value can safely be set per
|
291
|
-
# request on the session
|
296
|
+
# request on the session.
|
292
297
|
#
|
293
298
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
294
299
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -485,6 +490,7 @@ module Aws::FSx
|
|
485
490
|
# resp.backup.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
486
491
|
# resp.backup.file_system.failure_details.message #=> String
|
487
492
|
# resp.backup.file_system.storage_capacity #=> Integer
|
493
|
+
# resp.backup.file_system.storage_type #=> String, one of "SSD", "HDD"
|
488
494
|
# resp.backup.file_system.vpc_id #=> String
|
489
495
|
# resp.backup.file_system.subnet_ids #=> Array
|
490
496
|
# resp.backup.file_system.subnet_ids[0] #=> String
|
@@ -503,7 +509,7 @@ module Aws::FSx
|
|
503
509
|
# resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
|
504
510
|
# resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
505
511
|
# resp.backup.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
506
|
-
# resp.backup.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
|
512
|
+
# resp.backup.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
|
507
513
|
# resp.backup.file_system.windows_configuration.remote_administration_endpoint #=> String
|
508
514
|
# resp.backup.file_system.windows_configuration.preferred_subnet_id #=> String
|
509
515
|
# resp.backup.file_system.windows_configuration.preferred_file_server_ip #=> String
|
@@ -521,6 +527,13 @@ module Aws::FSx
|
|
521
527
|
# resp.backup.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
|
522
528
|
# resp.backup.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
|
523
529
|
# resp.backup.file_system.lustre_configuration.mount_name #=> String
|
530
|
+
# resp.backup.file_system.administrative_actions #=> Array
|
531
|
+
# resp.backup.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
|
532
|
+
# resp.backup.file_system.administrative_actions[0].progress_percent #=> Integer
|
533
|
+
# resp.backup.file_system.administrative_actions[0].request_time #=> Time
|
534
|
+
# resp.backup.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
535
|
+
# resp.backup.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
536
|
+
# resp.backup.file_system.administrative_actions[0].failure_details.message #=> String
|
524
537
|
# resp.backup.directory_information.domain_name #=> String
|
525
538
|
# resp.backup.directory_information.active_directory_id #=> String
|
526
539
|
#
|
@@ -542,13 +555,13 @@ module Aws::FSx
|
|
542
555
|
# `CreateDataRepositoryTask` operation will fail if a data repository is
|
543
556
|
# not linked to the FSx file system. To learn more about data repository
|
544
557
|
# tasks, see [Using Data Repository Tasks][1]. To learn more about
|
545
|
-
# linking a data repository to your file system, see [
|
546
|
-
#
|
558
|
+
# linking a data repository to your file system, see [Setting the Export
|
559
|
+
# Prefix][2].
|
547
560
|
#
|
548
561
|
#
|
549
562
|
#
|
550
563
|
# [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html
|
551
|
-
# [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/
|
564
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/export-data-repository.html#export-prefix
|
552
565
|
#
|
553
566
|
# @option params [required, String] :type
|
554
567
|
# Specifies the type of data repository task to create.
|
@@ -556,7 +569,11 @@ module Aws::FSx
|
|
556
569
|
# @option params [Array<String>] :paths
|
557
570
|
# (Optional) The path or paths on the Amazon FSx file system to use when
|
558
571
|
# the data repository task is processed. The default path is the file
|
559
|
-
# system root directory.
|
572
|
+
# system root directory. The paths you provide need to be relative to
|
573
|
+
# the mount point of the file system. If the mount point is `/mnt/fsx`
|
574
|
+
# and `/mnt/fsx/path1` is a directory or file on the file system you
|
575
|
+
# want to export, then the path to provide is `path1`. If a path that
|
576
|
+
# you provide isn't valid, the task fails.
|
560
577
|
#
|
561
578
|
# @option params [required, String] :file_system_id
|
562
579
|
# The globally unique ID of the file system, assigned by Amazon FSx.
|
@@ -565,7 +582,12 @@ module Aws::FSx
|
|
565
582
|
# Defines whether or not Amazon FSx provides a CompletionReport once the
|
566
583
|
# task has completed. A CompletionReport provides a detailed report on
|
567
584
|
# the files that Amazon FSx processed that meet the criteria specified
|
568
|
-
# by the `Scope` parameter.
|
585
|
+
# by the `Scope` parameter. For more information, see [Working with Task
|
586
|
+
# Completion Reports][1].
|
587
|
+
#
|
588
|
+
#
|
589
|
+
#
|
590
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/task-completion-report.html
|
569
591
|
#
|
570
592
|
# @option params [String] :client_request_token
|
571
593
|
# (Optional) An idempotency token for resource creation, in a string of
|
@@ -686,14 +708,39 @@ module Aws::FSx
|
|
686
708
|
# `LUSTRE`.
|
687
709
|
#
|
688
710
|
# @option params [required, Integer] :storage_capacity
|
689
|
-
#
|
711
|
+
# Sets the storage capacity of the file system that you're creating.
|
712
|
+
#
|
713
|
+
# For Lustre file systems:
|
714
|
+
#
|
715
|
+
# * For `SCRATCH_2` and `PERSISTENT_1` deployment types, valid values
|
716
|
+
# are 1.2, 2.4, and increments of 2.4 TiB.
|
717
|
+
#
|
718
|
+
# * For `SCRATCH_1` deployment type, valid values are 1.2, 2.4, and
|
719
|
+
# increments of 3.6 TiB.
|
720
|
+
#
|
721
|
+
# For Windows file systems:
|
722
|
+
#
|
723
|
+
# * If `StorageType=SSD`, valid values are 32 GiB - 65,536 GiB (64 TiB).
|
724
|
+
#
|
725
|
+
# * If `StorageType=HDD`, valid values are 2000 GiB - 65,536 GiB (64
|
726
|
+
# TiB).
|
690
727
|
#
|
691
|
-
#
|
728
|
+
# @option params [String] :storage_type
|
729
|
+
# Sets the storage type for the Amazon FSx for Windows file system
|
730
|
+
# you're creating. Valid values are `SSD` and `HDD`.
|
692
731
|
#
|
693
|
-
#
|
694
|
-
#
|
695
|
-
#
|
696
|
-
#
|
732
|
+
# * Set to `SSD` to use solid state drive storage. SSD is supported on
|
733
|
+
# all Windows deployment types.
|
734
|
+
#
|
735
|
+
# * Set to `HDD` to use hard disk drive storage. HDD is supported on
|
736
|
+
# `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types.
|
737
|
+
#
|
738
|
+
# Default value is `SSD`. For more information, see [ Storage Type
|
739
|
+
# Options][1] in the *Amazon FSx for Windows User Guide*.
|
740
|
+
#
|
741
|
+
#
|
742
|
+
#
|
743
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/optimize-fsx-costs.html#storage-type-options
|
697
744
|
#
|
698
745
|
# @option params [required, Array<String>] :subnet_ids
|
699
746
|
# Specifies the IDs of the subnets that the file system will be
|
@@ -703,9 +750,9 @@ module Aws::FSx
|
|
703
750
|
# subnets as the preferred subnet using the `WindowsConfiguration >
|
704
751
|
# PreferredSubnetID` property.
|
705
752
|
#
|
706
|
-
# For Windows `SINGLE_AZ_1` file system deployment
|
707
|
-
# systems, provide exactly one subnet ID. The file
|
708
|
-
# that subnet's Availability Zone.
|
753
|
+
# For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment
|
754
|
+
# types and Lustre file systems, provide exactly one subnet ID. The file
|
755
|
+
# server is launched in that subnet's Availability Zone.
|
709
756
|
#
|
710
757
|
# @option params [Array<String>] :security_group_ids
|
711
758
|
# A list of IDs specifying the security groups to apply to all network
|
@@ -732,11 +779,9 @@ module Aws::FSx
|
|
732
779
|
#
|
733
780
|
# @option params [Types::CreateFileSystemWindowsConfiguration] :windows_configuration
|
734
781
|
# The Microsoft Windows configuration for the file system being created.
|
735
|
-
# This value is required if `FileSystemType` is set to `WINDOWS`.
|
736
782
|
#
|
737
783
|
# @option params [Types::CreateFileSystemLustreConfiguration] :lustre_configuration
|
738
|
-
# The Lustre configuration for the file system being created.
|
739
|
-
# is required if `FileSystemType` is set to `LUSTRE`.
|
784
|
+
# The Lustre configuration for the file system being created.
|
740
785
|
#
|
741
786
|
# @return [Types::CreateFileSystemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
742
787
|
#
|
@@ -810,6 +855,7 @@ module Aws::FSx
|
|
810
855
|
# client_request_token: "ClientRequestToken",
|
811
856
|
# file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE
|
812
857
|
# storage_capacity: 1, # required
|
858
|
+
# storage_type: "SSD", # accepts SSD, HDD
|
813
859
|
# subnet_ids: ["SubnetId"], # required
|
814
860
|
# security_group_ids: ["SecurityGroupId"],
|
815
861
|
# tags: [
|
@@ -829,7 +875,7 @@ module Aws::FSx
|
|
829
875
|
# password: "DirectoryPassword", # required
|
830
876
|
# dns_ips: ["IpAddress"], # required
|
831
877
|
# },
|
832
|
-
# deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1
|
878
|
+
# deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
|
833
879
|
# preferred_subnet_id: "SubnetId",
|
834
880
|
# throughput_capacity: 1, # required
|
835
881
|
# weekly_maintenance_start_time: "WeeklyTime",
|
@@ -856,6 +902,7 @@ module Aws::FSx
|
|
856
902
|
# resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
857
903
|
# resp.file_system.failure_details.message #=> String
|
858
904
|
# resp.file_system.storage_capacity #=> Integer
|
905
|
+
# resp.file_system.storage_type #=> String, one of "SSD", "HDD"
|
859
906
|
# resp.file_system.vpc_id #=> String
|
860
907
|
# resp.file_system.subnet_ids #=> Array
|
861
908
|
# resp.file_system.subnet_ids[0] #=> String
|
@@ -874,7 +921,7 @@ module Aws::FSx
|
|
874
921
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
|
875
922
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
876
923
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
877
|
-
# resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
|
924
|
+
# resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
|
878
925
|
# resp.file_system.windows_configuration.remote_administration_endpoint #=> String
|
879
926
|
# resp.file_system.windows_configuration.preferred_subnet_id #=> String
|
880
927
|
# resp.file_system.windows_configuration.preferred_file_server_ip #=> String
|
@@ -892,6 +939,13 @@ module Aws::FSx
|
|
892
939
|
# resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
|
893
940
|
# resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
|
894
941
|
# resp.file_system.lustre_configuration.mount_name #=> String
|
942
|
+
# resp.file_system.administrative_actions #=> Array
|
943
|
+
# resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
|
944
|
+
# resp.file_system.administrative_actions[0].progress_percent #=> Integer
|
945
|
+
# resp.file_system.administrative_actions[0].request_time #=> Time
|
946
|
+
# resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
947
|
+
# resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
948
|
+
# resp.file_system.administrative_actions[0].failure_details.message #=> String
|
895
949
|
#
|
896
950
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystem AWS API Documentation
|
897
951
|
#
|
@@ -953,15 +1007,22 @@ module Aws::FSx
|
|
953
1007
|
# not need to pass this option.**
|
954
1008
|
#
|
955
1009
|
# @option params [required, Array<String>] :subnet_ids
|
956
|
-
#
|
957
|
-
# from.
|
958
|
-
#
|
1010
|
+
# Specifies the IDs of the subnets that the file system will be
|
1011
|
+
# accessible from. For Windows `MULTI_AZ_1` file system deployment
|
1012
|
+
# types, provide exactly two subnet IDs, one for the preferred file
|
1013
|
+
# server and one for the standby file server. You specify one of these
|
1014
|
+
# subnets as the preferred subnet using the `WindowsConfiguration >
|
1015
|
+
# PreferredSubnetID` property.
|
1016
|
+
#
|
1017
|
+
# For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` deployment types and
|
1018
|
+
# Lustre file systems, provide exactly one subnet ID. The file server is
|
1019
|
+
# launched in that subnet's Availability Zone.
|
959
1020
|
#
|
960
1021
|
# @option params [Array<String>] :security_group_ids
|
961
1022
|
# A list of IDs for the security groups that apply to the specified
|
962
1023
|
# network interfaces created for file system access. These security
|
963
1024
|
# groups apply to all network interfaces. This value isn't returned in
|
964
|
-
# later
|
1025
|
+
# later DescribeFileSystem requests.
|
965
1026
|
#
|
966
1027
|
# @option params [Array<Types::Tag>] :tags
|
967
1028
|
# The tags to be applied to the file system at file system creation. The
|
@@ -971,6 +1032,27 @@ module Aws::FSx
|
|
971
1032
|
# @option params [Types::CreateFileSystemWindowsConfiguration] :windows_configuration
|
972
1033
|
# The configuration for this Microsoft Windows file system.
|
973
1034
|
#
|
1035
|
+
# @option params [String] :storage_type
|
1036
|
+
# Sets the storage type for the Windows file system you're creating
|
1037
|
+
# from a backup. Valid values are `SSD` and `HDD`.
|
1038
|
+
#
|
1039
|
+
# * Set to `SSD` to use solid state drive storage. Supported on all
|
1040
|
+
# Windows deployment types.
|
1041
|
+
#
|
1042
|
+
# * Set to `HDD` to use hard disk drive storage. Supported on
|
1043
|
+
# `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types.
|
1044
|
+
#
|
1045
|
+
# Default value is `SSD`.
|
1046
|
+
#
|
1047
|
+
# <note markdown="1"> HDD and SSD storage types have different minimum storage capacity
|
1048
|
+
# requirements. A restored file system's storage capacity is tied to
|
1049
|
+
# the file system that was backed up. You can create a file system that
|
1050
|
+
# uses HDD storage from a backup of a file system that used SSD storage
|
1051
|
+
# only if the original SSD file system had a storage capacity of at
|
1052
|
+
# least 2000 GiB.
|
1053
|
+
#
|
1054
|
+
# </note>
|
1055
|
+
#
|
974
1056
|
# @return [Types::CreateFileSystemFromBackupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
975
1057
|
#
|
976
1058
|
# * {Types::CreateFileSystemFromBackupResponse#file_system #file_system} => Types::FileSystem
|
@@ -1054,7 +1136,7 @@ module Aws::FSx
|
|
1054
1136
|
# password: "DirectoryPassword", # required
|
1055
1137
|
# dns_ips: ["IpAddress"], # required
|
1056
1138
|
# },
|
1057
|
-
# deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1
|
1139
|
+
# deployment_type: "MULTI_AZ_1", # accepts MULTI_AZ_1, SINGLE_AZ_1, SINGLE_AZ_2
|
1058
1140
|
# preferred_subnet_id: "SubnetId",
|
1059
1141
|
# throughput_capacity: 1, # required
|
1060
1142
|
# weekly_maintenance_start_time: "WeeklyTime",
|
@@ -1062,6 +1144,7 @@ module Aws::FSx
|
|
1062
1144
|
# automatic_backup_retention_days: 1,
|
1063
1145
|
# copy_tags_to_backups: false,
|
1064
1146
|
# },
|
1147
|
+
# storage_type: "SSD", # accepts SSD, HDD
|
1065
1148
|
# })
|
1066
1149
|
#
|
1067
1150
|
# @example Response structure
|
@@ -1073,6 +1156,7 @@ module Aws::FSx
|
|
1073
1156
|
# resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
1074
1157
|
# resp.file_system.failure_details.message #=> String
|
1075
1158
|
# resp.file_system.storage_capacity #=> Integer
|
1159
|
+
# resp.file_system.storage_type #=> String, one of "SSD", "HDD"
|
1076
1160
|
# resp.file_system.vpc_id #=> String
|
1077
1161
|
# resp.file_system.subnet_ids #=> Array
|
1078
1162
|
# resp.file_system.subnet_ids[0] #=> String
|
@@ -1091,7 +1175,7 @@ module Aws::FSx
|
|
1091
1175
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
|
1092
1176
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
1093
1177
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
1094
|
-
# resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
|
1178
|
+
# resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
|
1095
1179
|
# resp.file_system.windows_configuration.remote_administration_endpoint #=> String
|
1096
1180
|
# resp.file_system.windows_configuration.preferred_subnet_id #=> String
|
1097
1181
|
# resp.file_system.windows_configuration.preferred_file_server_ip #=> String
|
@@ -1109,6 +1193,13 @@ module Aws::FSx
|
|
1109
1193
|
# resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
|
1110
1194
|
# resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
|
1111
1195
|
# resp.file_system.lustre_configuration.mount_name #=> String
|
1196
|
+
# resp.file_system.administrative_actions #=> Array
|
1197
|
+
# resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
|
1198
|
+
# resp.file_system.administrative_actions[0].progress_percent #=> Integer
|
1199
|
+
# resp.file_system.administrative_actions[0].request_time #=> Time
|
1200
|
+
# resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
1201
|
+
# resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
1202
|
+
# resp.file_system.administrative_actions[0].failure_details.message #=> String
|
1112
1203
|
#
|
1113
1204
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackup AWS API Documentation
|
1114
1205
|
#
|
@@ -1329,6 +1420,8 @@ module Aws::FSx
|
|
1329
1420
|
# * {Types::DescribeBackupsResponse#backups #backups} => Array<Types::Backup>
|
1330
1421
|
# * {Types::DescribeBackupsResponse#next_token #next_token} => String
|
1331
1422
|
#
|
1423
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1424
|
+
#
|
1332
1425
|
#
|
1333
1426
|
# @example Example: To describe Amazon FSx backups
|
1334
1427
|
#
|
@@ -1402,6 +1495,7 @@ module Aws::FSx
|
|
1402
1495
|
# resp.backups[0].file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
1403
1496
|
# resp.backups[0].file_system.failure_details.message #=> String
|
1404
1497
|
# resp.backups[0].file_system.storage_capacity #=> Integer
|
1498
|
+
# resp.backups[0].file_system.storage_type #=> String, one of "SSD", "HDD"
|
1405
1499
|
# resp.backups[0].file_system.vpc_id #=> String
|
1406
1500
|
# resp.backups[0].file_system.subnet_ids #=> Array
|
1407
1501
|
# resp.backups[0].file_system.subnet_ids[0] #=> String
|
@@ -1420,7 +1514,7 @@ module Aws::FSx
|
|
1420
1514
|
# resp.backups[0].file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
|
1421
1515
|
# resp.backups[0].file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
1422
1516
|
# resp.backups[0].file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
1423
|
-
# resp.backups[0].file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
|
1517
|
+
# resp.backups[0].file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
|
1424
1518
|
# resp.backups[0].file_system.windows_configuration.remote_administration_endpoint #=> String
|
1425
1519
|
# resp.backups[0].file_system.windows_configuration.preferred_subnet_id #=> String
|
1426
1520
|
# resp.backups[0].file_system.windows_configuration.preferred_file_server_ip #=> String
|
@@ -1438,6 +1532,13 @@ module Aws::FSx
|
|
1438
1532
|
# resp.backups[0].file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
|
1439
1533
|
# resp.backups[0].file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
|
1440
1534
|
# resp.backups[0].file_system.lustre_configuration.mount_name #=> String
|
1535
|
+
# resp.backups[0].file_system.administrative_actions #=> Array
|
1536
|
+
# resp.backups[0].file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
|
1537
|
+
# resp.backups[0].file_system.administrative_actions[0].progress_percent #=> Integer
|
1538
|
+
# resp.backups[0].file_system.administrative_actions[0].request_time #=> Time
|
1539
|
+
# resp.backups[0].file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
1540
|
+
# resp.backups[0].file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
1541
|
+
# resp.backups[0].file_system.administrative_actions[0].failure_details.message #=> String
|
1441
1542
|
# resp.backups[0].directory_information.domain_name #=> String
|
1442
1543
|
# resp.backups[0].directory_information.active_directory_id #=> String
|
1443
1544
|
# resp.next_token #=> String
|
@@ -1490,6 +1591,8 @@ module Aws::FSx
|
|
1490
1591
|
# * {Types::DescribeDataRepositoryTasksResponse#data_repository_tasks #data_repository_tasks} => Array<Types::DataRepositoryTask>
|
1491
1592
|
# * {Types::DescribeDataRepositoryTasksResponse#next_token #next_token} => String
|
1492
1593
|
#
|
1594
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1595
|
+
#
|
1493
1596
|
# @example Request syntax with placeholder values
|
1494
1597
|
#
|
1495
1598
|
# resp = client.describe_data_repository_tasks({
|
@@ -1588,6 +1691,8 @@ module Aws::FSx
|
|
1588
1691
|
# * {Types::DescribeFileSystemsResponse#file_systems #file_systems} => Array<Types::FileSystem>
|
1589
1692
|
# * {Types::DescribeFileSystemsResponse#next_token #next_token} => String
|
1590
1693
|
#
|
1694
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1695
|
+
#
|
1591
1696
|
#
|
1592
1697
|
# @example Example: To describe an Amazon FSx file system
|
1593
1698
|
#
|
@@ -1650,6 +1755,7 @@ module Aws::FSx
|
|
1650
1755
|
# resp.file_systems[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
1651
1756
|
# resp.file_systems[0].failure_details.message #=> String
|
1652
1757
|
# resp.file_systems[0].storage_capacity #=> Integer
|
1758
|
+
# resp.file_systems[0].storage_type #=> String, one of "SSD", "HDD"
|
1653
1759
|
# resp.file_systems[0].vpc_id #=> String
|
1654
1760
|
# resp.file_systems[0].subnet_ids #=> Array
|
1655
1761
|
# resp.file_systems[0].subnet_ids[0] #=> String
|
@@ -1668,7 +1774,7 @@ module Aws::FSx
|
|
1668
1774
|
# resp.file_systems[0].windows_configuration.self_managed_active_directory_configuration.user_name #=> String
|
1669
1775
|
# resp.file_systems[0].windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
1670
1776
|
# resp.file_systems[0].windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
1671
|
-
# resp.file_systems[0].windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
|
1777
|
+
# resp.file_systems[0].windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
|
1672
1778
|
# resp.file_systems[0].windows_configuration.remote_administration_endpoint #=> String
|
1673
1779
|
# resp.file_systems[0].windows_configuration.preferred_subnet_id #=> String
|
1674
1780
|
# resp.file_systems[0].windows_configuration.preferred_file_server_ip #=> String
|
@@ -1686,6 +1792,13 @@ module Aws::FSx
|
|
1686
1792
|
# resp.file_systems[0].lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
|
1687
1793
|
# resp.file_systems[0].lustre_configuration.per_unit_storage_throughput #=> Integer
|
1688
1794
|
# resp.file_systems[0].lustre_configuration.mount_name #=> String
|
1795
|
+
# resp.file_systems[0].administrative_actions #=> Array
|
1796
|
+
# resp.file_systems[0].administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
|
1797
|
+
# resp.file_systems[0].administrative_actions[0].progress_percent #=> Integer
|
1798
|
+
# resp.file_systems[0].administrative_actions[0].request_time #=> Time
|
1799
|
+
# resp.file_systems[0].administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
1800
|
+
# resp.file_systems[0].administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
1801
|
+
# resp.file_systems[0].administrative_actions[0].failure_details.message #=> String
|
1689
1802
|
# resp.next_token #=> String
|
1690
1803
|
#
|
1691
1804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystems AWS API Documentation
|
@@ -1871,24 +1984,54 @@ module Aws::FSx
|
|
1871
1984
|
req.send_request(options)
|
1872
1985
|
end
|
1873
1986
|
|
1874
|
-
#
|
1987
|
+
# Use this operation to update the configuration of an existing Amazon
|
1988
|
+
# FSx file system. For an Amazon FSx for Lustre file system, you can
|
1989
|
+
# update only the WeeklyMaintenanceStartTime. For an Amazon for Windows
|
1990
|
+
# File Server file system, you can update the following properties:
|
1991
|
+
#
|
1992
|
+
# * AutomaticBackupRetentionDays
|
1993
|
+
#
|
1994
|
+
# * DailyAutomaticBackupStartTime
|
1995
|
+
#
|
1996
|
+
# * SelfManagedActiveDirectoryConfiguration
|
1997
|
+
#
|
1998
|
+
# * StorageCapacity
|
1999
|
+
#
|
2000
|
+
# * ThroughputCapacity
|
2001
|
+
#
|
2002
|
+
# * WeeklyMaintenanceStartTime
|
2003
|
+
#
|
2004
|
+
# You can update multiple properties in a single request.
|
1875
2005
|
#
|
1876
2006
|
# @option params [required, String] :file_system_id
|
1877
|
-
#
|
2007
|
+
# Identifies the file system that you are updating.
|
1878
2008
|
#
|
1879
2009
|
# @option params [String] :client_request_token
|
1880
|
-
#
|
1881
|
-
#
|
1882
|
-
#
|
1883
|
-
# an AWS SDK.
|
2010
|
+
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
2011
|
+
# idempotent updates. This string is automatically filled on your behalf
|
2012
|
+
# when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
|
1884
2013
|
#
|
1885
2014
|
# **A suitable default value is auto-generated.** You should normally
|
1886
2015
|
# not need to pass this option.**
|
1887
2016
|
#
|
2017
|
+
# @option params [Integer] :storage_capacity
|
2018
|
+
# Use this parameter to increase the storage capacity of an Amazon FSx
|
2019
|
+
# for Windows File Server file system. Specifies the storage capacity
|
2020
|
+
# target value, GiB, for the file system you're updating. The storage
|
2021
|
+
# capacity target value must be at least 10 percent (%) greater than the
|
2022
|
+
# current storage capacity value. In order to increase storage capacity,
|
2023
|
+
# the file system needs to have at least 16 MB/s of throughput capacity.
|
2024
|
+
# You cannot make a storage capacity increase request if there is an
|
2025
|
+
# existing storage capacity increase request in progress. For more
|
2026
|
+
# information, see [Managing Storage Capacity][1].
|
2027
|
+
#
|
2028
|
+
#
|
2029
|
+
#
|
2030
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
|
2031
|
+
#
|
1888
2032
|
# @option params [Types::UpdateFileSystemWindowsConfiguration] :windows_configuration
|
1889
|
-
# The configuration
|
1890
|
-
#
|
1891
|
-
# self-managed Active Directory configuration.
|
2033
|
+
# The configuration updates for an Amazon FSx for Windows File Server
|
2034
|
+
# file system.
|
1892
2035
|
#
|
1893
2036
|
# @option params [Types::UpdateFileSystemLustreConfiguration] :lustre_configuration
|
1894
2037
|
# The configuration object for Amazon FSx for Lustre file systems used
|
@@ -1947,10 +2090,12 @@ module Aws::FSx
|
|
1947
2090
|
# resp = client.update_file_system({
|
1948
2091
|
# file_system_id: "FileSystemId", # required
|
1949
2092
|
# client_request_token: "ClientRequestToken",
|
2093
|
+
# storage_capacity: 1,
|
1950
2094
|
# windows_configuration: {
|
1951
2095
|
# weekly_maintenance_start_time: "WeeklyTime",
|
1952
2096
|
# daily_automatic_backup_start_time: "DailyTime",
|
1953
2097
|
# automatic_backup_retention_days: 1,
|
2098
|
+
# throughput_capacity: 1,
|
1954
2099
|
# self_managed_active_directory_configuration: {
|
1955
2100
|
# user_name: "DirectoryUserName",
|
1956
2101
|
# password: "DirectoryPassword",
|
@@ -1971,6 +2116,7 @@ module Aws::FSx
|
|
1971
2116
|
# resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
1972
2117
|
# resp.file_system.failure_details.message #=> String
|
1973
2118
|
# resp.file_system.storage_capacity #=> Integer
|
2119
|
+
# resp.file_system.storage_type #=> String, one of "SSD", "HDD"
|
1974
2120
|
# resp.file_system.vpc_id #=> String
|
1975
2121
|
# resp.file_system.subnet_ids #=> Array
|
1976
2122
|
# resp.file_system.subnet_ids[0] #=> String
|
@@ -1989,7 +2135,7 @@ module Aws::FSx
|
|
1989
2135
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.user_name #=> String
|
1990
2136
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
1991
2137
|
# resp.file_system.windows_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
1992
|
-
# resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1"
|
2138
|
+
# resp.file_system.windows_configuration.deployment_type #=> String, one of "MULTI_AZ_1", "SINGLE_AZ_1", "SINGLE_AZ_2"
|
1993
2139
|
# resp.file_system.windows_configuration.remote_administration_endpoint #=> String
|
1994
2140
|
# resp.file_system.windows_configuration.preferred_subnet_id #=> String
|
1995
2141
|
# resp.file_system.windows_configuration.preferred_file_server_ip #=> String
|
@@ -2007,6 +2153,13 @@ module Aws::FSx
|
|
2007
2153
|
# resp.file_system.lustre_configuration.deployment_type #=> String, one of "SCRATCH_1", "SCRATCH_2", "PERSISTENT_1"
|
2008
2154
|
# resp.file_system.lustre_configuration.per_unit_storage_throughput #=> Integer
|
2009
2155
|
# resp.file_system.lustre_configuration.mount_name #=> String
|
2156
|
+
# resp.file_system.administrative_actions #=> Array
|
2157
|
+
# resp.file_system.administrative_actions[0].administrative_action_type #=> String, one of "FILE_SYSTEM_UPDATE", "STORAGE_OPTIMIZATION"
|
2158
|
+
# resp.file_system.administrative_actions[0].progress_percent #=> Integer
|
2159
|
+
# resp.file_system.administrative_actions[0].request_time #=> Time
|
2160
|
+
# resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
2161
|
+
# resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
2162
|
+
# resp.file_system.administrative_actions[0].failure_details.message #=> String
|
2010
2163
|
#
|
2011
2164
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystem AWS API Documentation
|
2012
2165
|
#
|
@@ -2030,7 +2183,7 @@ module Aws::FSx
|
|
2030
2183
|
params: params,
|
2031
2184
|
config: config)
|
2032
2185
|
context[:gem_name] = 'aws-sdk-fsx'
|
2033
|
-
context[:gem_version] = '1.
|
2186
|
+
context[:gem_version] = '1.21.1'
|
2034
2187
|
Seahorse::Client::Request.new(handlers, context)
|
2035
2188
|
end
|
2036
2189
|
|