aws-sdk-fsx 1.41.0 → 1.45.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-fsx/client.rb +1276 -106
- data/lib/aws-sdk-fsx/client_api.rb +490 -1
- data/lib/aws-sdk-fsx/errors.rb +53 -0
- data/lib/aws-sdk-fsx/types.rb +2195 -343
- data/lib/aws-sdk-fsx.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-fsx/client.rb
CHANGED
@@ -285,6 +285,15 @@ module Aws::FSx
|
|
285
285
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
286
286
|
# requests are made, and retries are disabled.
|
287
287
|
#
|
288
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
289
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
290
|
+
# will be used if available.
|
291
|
+
#
|
292
|
+
# @option options [Boolean] :use_fips_endpoint
|
293
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
294
|
+
# When a `fips` region is used, the region is normalized and this config
|
295
|
+
# is set to `true`.
|
296
|
+
#
|
288
297
|
# @option options [Boolean] :validate_params (true)
|
289
298
|
# When `true`, request parameters are validated before
|
290
299
|
# sending the request.
|
@@ -339,7 +348,7 @@ module Aws::FSx
|
|
339
348
|
|
340
349
|
# Use this action to associate one or more Domain Name Server (DNS)
|
341
350
|
# aliases with an existing Amazon FSx for Windows File Server file
|
342
|
-
# system. A file
|
351
|
+
# system. A file system can have a maximum of 50 DNS aliases associated
|
343
352
|
# with it at any one time. If you try to associate a DNS alias that is
|
344
353
|
# already associated with the file system, FSx takes no action on that
|
345
354
|
# alias in the request. For more information, see [Working with DNS
|
@@ -360,8 +369,8 @@ module Aws::FSx
|
|
360
369
|
# @option params [String] :client_request_token
|
361
370
|
# (Optional) An idempotency token for resource creation, in a string of
|
362
371
|
# up to 64 ASCII characters. This token is automatically filled on your
|
363
|
-
# behalf when you use the
|
364
|
-
# SDK.
|
372
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
373
|
+
# Services SDK.
|
365
374
|
#
|
366
375
|
# **A suitable default value is auto-generated.** You should normally
|
367
376
|
# not need to pass this option.**
|
@@ -456,28 +465,29 @@ module Aws::FSx
|
|
456
465
|
req.send_request(options)
|
457
466
|
end
|
458
467
|
|
459
|
-
# Copies an existing backup within the same
|
460
|
-
# Region (cross-Region copy) or within
|
461
|
-
#
|
462
|
-
#
|
468
|
+
# Copies an existing backup within the same Amazon Web Services account
|
469
|
+
# to another Amazon Web Services Region (cross-Region copy) or within
|
470
|
+
# the same Amazon Web Services Region (in-Region copy). You can have up
|
471
|
+
# to five backup copy requests in progress to a single destination
|
472
|
+
# Region per account.
|
463
473
|
#
|
464
474
|
# You can use cross-Region backup copies for cross-region disaster
|
465
475
|
# recovery. You periodically take backups and copy them to another
|
466
476
|
# Region so that in the event of a disaster in the primary Region, you
|
467
477
|
# can restore from backup and recover availability quickly in the other
|
468
|
-
# Region. You can make cross-Region copies only within your
|
469
|
-
# partition.
|
478
|
+
# Region. You can make cross-Region copies only within your Amazon Web
|
479
|
+
# Services partition.
|
470
480
|
#
|
471
481
|
# You can also use backup copies to clone your file data set to another
|
472
482
|
# Region or within the same Region.
|
473
483
|
#
|
474
|
-
# You can use the `SourceRegion` parameter to specify the
|
475
|
-
# from which the backup will be copied. For example, if
|
476
|
-
# call from the `us-west-1` Region and want to copy a
|
477
|
-
# `us-east-2` Region, you specify `us-east-2` in the
|
478
|
-
# parameter to make a cross-Region copy. If you don't
|
479
|
-
# the backup copy is created in the same Region where
|
480
|
-
# sent from (in-Region copy).
|
484
|
+
# You can use the `SourceRegion` parameter to specify the Amazon Web
|
485
|
+
# Services Region from which the backup will be copied. For example, if
|
486
|
+
# you make the call from the `us-west-1` Region and want to copy a
|
487
|
+
# backup from the `us-east-2` Region, you specify `us-east-2` in the
|
488
|
+
# `SourceRegion` parameter to make a cross-Region copy. If you don't
|
489
|
+
# specify a Region, the backup copy is created in the same Region where
|
490
|
+
# the request is sent from (in-Region copy).
|
481
491
|
#
|
482
492
|
# For more information on creating backup copies, see [ Copying
|
483
493
|
# backups][1] in the *Amazon FSx for Windows User Guide* and [Copying
|
@@ -491,8 +501,8 @@ module Aws::FSx
|
|
491
501
|
# @option params [String] :client_request_token
|
492
502
|
# (Optional) An idempotency token for resource creation, in a string of
|
493
503
|
# up to 64 ASCII characters. This token is automatically filled on your
|
494
|
-
# behalf when you use the
|
495
|
-
# SDK.
|
504
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
505
|
+
# Services SDK.
|
496
506
|
#
|
497
507
|
# **A suitable default value is auto-generated.** You should normally
|
498
508
|
# not need to pass this option.**
|
@@ -502,21 +512,21 @@ module Aws::FSx
|
|
502
512
|
# being copied.
|
503
513
|
#
|
504
514
|
# @option params [String] :source_region
|
505
|
-
# The source
|
506
|
-
# which the backup is being copied. The
|
507
|
-
# must be in the same
|
508
|
-
#
|
509
|
-
# copy).
|
515
|
+
# The source Amazon Web Services Region of the backup. Specifies the
|
516
|
+
# Amazon Web Services Region from which the backup is being copied. The
|
517
|
+
# source and destination Regions must be in the same Amazon Web Services
|
518
|
+
# partition. If you don't specify a Region, it defaults to the Region
|
519
|
+
# where the request is sent from (in-Region copy).
|
510
520
|
#
|
511
521
|
# @option params [String] :kms_key_id
|
512
|
-
# The ID of the
|
513
|
-
#
|
514
|
-
# systems
|
515
|
-
#
|
516
|
-
# The Amazon FSx for Lustre `SCRATCH_1`
|
517
|
-
# always encrypted at rest using Amazon
|
518
|
-
# information, see [Encrypt][1] in the *
|
519
|
-
# Reference*.
|
522
|
+
# The ID of the Key Management Service (KMS) key used to encrypt the
|
523
|
+
# file system's data for Amazon FSx for Windows File Server file
|
524
|
+
# systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for
|
525
|
+
# Lustre `PERSISTENT_1` file systems at rest. If not specified, the
|
526
|
+
# Amazon FSx managed key is used. The Amazon FSx for Lustre `SCRATCH_1`
|
527
|
+
# and `SCRATCH_2` file systems are always encrypted at rest using Amazon
|
528
|
+
# FSx managed keys. For more information, see [Encrypt][1] in the *Key
|
529
|
+
# Management Service API Reference*.
|
520
530
|
#
|
521
531
|
#
|
522
532
|
#
|
@@ -614,7 +624,7 @@ module Aws::FSx
|
|
614
624
|
# resp.backup.file_system.owner_id #=> String
|
615
625
|
# resp.backup.file_system.creation_time #=> Time
|
616
626
|
# resp.backup.file_system.file_system_id #=> String
|
617
|
-
# resp.backup.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE"
|
627
|
+
# resp.backup.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP"
|
618
628
|
# resp.backup.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
619
629
|
# resp.backup.file_system.failure_details.message #=> String
|
620
630
|
# resp.backup.file_system.storage_capacity #=> Integer
|
@@ -676,12 +686,75 @@ module Aws::FSx
|
|
676
686
|
# resp.backup.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
677
687
|
# resp.backup.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
678
688
|
# resp.backup.file_system.administrative_actions[0].failure_details.message #=> String
|
689
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
|
690
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
|
691
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
692
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.name #=> String
|
693
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
694
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
|
695
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
696
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
|
697
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
698
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
|
699
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
700
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
701
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
702
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
|
703
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
704
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
|
705
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.tags #=> Array
|
706
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
|
707
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
|
708
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
|
709
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP"
|
710
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
|
711
|
+
# resp.backup.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
|
712
|
+
# resp.backup.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
|
713
|
+
# resp.backup.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1"
|
714
|
+
# resp.backup.file_system.ontap_configuration.endpoint_ip_address_range #=> String
|
715
|
+
# resp.backup.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
|
716
|
+
# resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
|
717
|
+
# resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
|
718
|
+
# resp.backup.file_system.ontap_configuration.endpoints.management.dns_name #=> String
|
719
|
+
# resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
|
720
|
+
# resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
|
721
|
+
# resp.backup.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
|
722
|
+
# resp.backup.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
|
723
|
+
# resp.backup.file_system.ontap_configuration.preferred_subnet_id #=> String
|
724
|
+
# resp.backup.file_system.ontap_configuration.route_table_ids #=> Array
|
725
|
+
# resp.backup.file_system.ontap_configuration.route_table_ids[0] #=> String
|
726
|
+
# resp.backup.file_system.ontap_configuration.throughput_capacity #=> Integer
|
727
|
+
# resp.backup.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
|
728
|
+
# resp.backup.file_system.file_system_type_version #=> String
|
679
729
|
# resp.backup.directory_information.domain_name #=> String
|
680
730
|
# resp.backup.directory_information.active_directory_id #=> String
|
681
731
|
# resp.backup.directory_information.resource_arn #=> String
|
682
732
|
# resp.backup.owner_id #=> String
|
683
733
|
# resp.backup.source_backup_id #=> String
|
684
734
|
# resp.backup.source_backup_region #=> String
|
735
|
+
# resp.backup.resource_type #=> String, one of "FILE_SYSTEM", "VOLUME"
|
736
|
+
# resp.backup.volume.creation_time #=> Time
|
737
|
+
# resp.backup.volume.file_system_id #=> String
|
738
|
+
# resp.backup.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
739
|
+
# resp.backup.volume.name #=> String
|
740
|
+
# resp.backup.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
741
|
+
# resp.backup.volume.ontap_configuration.junction_path #=> String
|
742
|
+
# resp.backup.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
743
|
+
# resp.backup.volume.ontap_configuration.size_in_megabytes #=> Integer
|
744
|
+
# resp.backup.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
745
|
+
# resp.backup.volume.ontap_configuration.storage_virtual_machine_id #=> String
|
746
|
+
# resp.backup.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
747
|
+
# resp.backup.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
748
|
+
# resp.backup.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
749
|
+
# resp.backup.volume.ontap_configuration.uuid #=> String
|
750
|
+
# resp.backup.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
751
|
+
# resp.backup.volume.resource_arn #=> String
|
752
|
+
# resp.backup.volume.tags #=> Array
|
753
|
+
# resp.backup.volume.tags[0].key #=> String
|
754
|
+
# resp.backup.volume.tags[0].value #=> String
|
755
|
+
# resp.backup.volume.volume_id #=> String
|
756
|
+
# resp.backup.volume.volume_type #=> String, one of "ONTAP"
|
757
|
+
# resp.backup.volume.lifecycle_transition_reason.message #=> String
|
685
758
|
#
|
686
759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CopyBackup AWS API Documentation
|
687
760
|
#
|
@@ -692,23 +765,29 @@ module Aws::FSx
|
|
692
765
|
req.send_request(options)
|
693
766
|
end
|
694
767
|
|
695
|
-
# Creates a backup of an existing Amazon FSx
|
696
|
-
#
|
697
|
-
#
|
698
|
-
#
|
768
|
+
# Creates a backup of an existing Amazon FSx for Windows File Server or
|
769
|
+
# Amazon FSx for Lustre file system, or of an Amazon FSx for NetApp
|
770
|
+
# ONTAP volume. Creating regular backups is a best practice, enabling
|
771
|
+
# you to restore a file system or volume from a backup if an issue
|
772
|
+
# arises with the original file system or volume.
|
699
773
|
#
|
700
774
|
# For Amazon FSx for Lustre file systems, you can create a backup only
|
701
775
|
# for file systems with the following configuration:
|
702
776
|
#
|
703
777
|
# * a Persistent deployment type
|
704
778
|
#
|
705
|
-
# * is *not* linked to a data
|
779
|
+
# * is *not* linked to a data repository.
|
706
780
|
#
|
707
|
-
# For more information about
|
708
|
-
# systems, see [Working with FSx for Lustre backups][1].
|
781
|
+
# For more information about backups, see the following:
|
709
782
|
#
|
710
|
-
# For
|
711
|
-
#
|
783
|
+
# * For Amazon FSx for Lustre, see [Working with FSx for Lustre
|
784
|
+
# backups][1].
|
785
|
+
#
|
786
|
+
# * For Amazon FSx for Windows, see [Working with FSx for Windows
|
787
|
+
# backups][2].
|
788
|
+
#
|
789
|
+
# * For Amazon FSx for NetApp ONTAP, see [Working with FSx for NetApp
|
790
|
+
# ONTAP backups][3].
|
712
791
|
#
|
713
792
|
# If a backup with the specified client request token exists, and the
|
714
793
|
# parameters match, this operation returns the description of the
|
@@ -738,15 +817,16 @@ module Aws::FSx
|
|
738
817
|
#
|
739
818
|
# [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/using-backups-fsx.html
|
740
819
|
# [2]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/using-backups.html
|
820
|
+
# [3]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/using-backups.html
|
741
821
|
#
|
742
|
-
# @option params [
|
822
|
+
# @option params [String] :file_system_id
|
743
823
|
# The ID of the file system to back up.
|
744
824
|
#
|
745
825
|
# @option params [String] :client_request_token
|
746
826
|
# (Optional) A string of up to 64 ASCII characters that Amazon FSx uses
|
747
827
|
# to ensure idempotent creation. This string is automatically filled on
|
748
|
-
# your behalf when you use the
|
749
|
-
#
|
828
|
+
# your behalf when you use the Command Line Interface (CLI) or an Amazon
|
829
|
+
# Web Services SDK.
|
750
830
|
#
|
751
831
|
# **A suitable default value is auto-generated.** You should normally
|
752
832
|
# not need to pass this option.**
|
@@ -758,6 +838,9 @@ module Aws::FSx
|
|
758
838
|
# tags using the `CreateBackup` action, no existing file system tags are
|
759
839
|
# copied from the file system to the backup.
|
760
840
|
#
|
841
|
+
# @option params [String] :volume_id
|
842
|
+
# The ID of he FSx for NetApp ONTAP volume to back up.
|
843
|
+
#
|
761
844
|
# @return [Types::CreateBackupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
762
845
|
#
|
763
846
|
# * {Types::CreateBackupResponse#backup #backup} => Types::Backup
|
@@ -809,7 +892,7 @@ module Aws::FSx
|
|
809
892
|
# @example Request syntax with placeholder values
|
810
893
|
#
|
811
894
|
# resp = client.create_backup({
|
812
|
-
# file_system_id: "FileSystemId",
|
895
|
+
# file_system_id: "FileSystemId",
|
813
896
|
# client_request_token: "ClientRequestToken",
|
814
897
|
# tags: [
|
815
898
|
# {
|
@@ -817,6 +900,7 @@ module Aws::FSx
|
|
817
900
|
# value: "TagValue", # required
|
818
901
|
# },
|
819
902
|
# ],
|
903
|
+
# volume_id: "VolumeId",
|
820
904
|
# })
|
821
905
|
#
|
822
906
|
# @example Response structure
|
@@ -835,7 +919,7 @@ module Aws::FSx
|
|
835
919
|
# resp.backup.file_system.owner_id #=> String
|
836
920
|
# resp.backup.file_system.creation_time #=> Time
|
837
921
|
# resp.backup.file_system.file_system_id #=> String
|
838
|
-
# resp.backup.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE"
|
922
|
+
# resp.backup.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP"
|
839
923
|
# resp.backup.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
840
924
|
# resp.backup.file_system.failure_details.message #=> String
|
841
925
|
# resp.backup.file_system.storage_capacity #=> Integer
|
@@ -897,12 +981,75 @@ module Aws::FSx
|
|
897
981
|
# resp.backup.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
898
982
|
# resp.backup.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
899
983
|
# resp.backup.file_system.administrative_actions[0].failure_details.message #=> String
|
984
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
|
985
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
|
986
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
987
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.name #=> String
|
988
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
989
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
|
990
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
991
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
|
992
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
993
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
|
994
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
995
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
996
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
997
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
|
998
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
999
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
|
1000
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.tags #=> Array
|
1001
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
|
1002
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
|
1003
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
|
1004
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP"
|
1005
|
+
# resp.backup.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
|
1006
|
+
# resp.backup.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
|
1007
|
+
# resp.backup.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
|
1008
|
+
# resp.backup.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1"
|
1009
|
+
# resp.backup.file_system.ontap_configuration.endpoint_ip_address_range #=> String
|
1010
|
+
# resp.backup.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
|
1011
|
+
# resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
|
1012
|
+
# resp.backup.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
|
1013
|
+
# resp.backup.file_system.ontap_configuration.endpoints.management.dns_name #=> String
|
1014
|
+
# resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
|
1015
|
+
# resp.backup.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
|
1016
|
+
# resp.backup.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
|
1017
|
+
# resp.backup.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
|
1018
|
+
# resp.backup.file_system.ontap_configuration.preferred_subnet_id #=> String
|
1019
|
+
# resp.backup.file_system.ontap_configuration.route_table_ids #=> Array
|
1020
|
+
# resp.backup.file_system.ontap_configuration.route_table_ids[0] #=> String
|
1021
|
+
# resp.backup.file_system.ontap_configuration.throughput_capacity #=> Integer
|
1022
|
+
# resp.backup.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
|
1023
|
+
# resp.backup.file_system.file_system_type_version #=> String
|
900
1024
|
# resp.backup.directory_information.domain_name #=> String
|
901
1025
|
# resp.backup.directory_information.active_directory_id #=> String
|
902
1026
|
# resp.backup.directory_information.resource_arn #=> String
|
903
1027
|
# resp.backup.owner_id #=> String
|
904
1028
|
# resp.backup.source_backup_id #=> String
|
905
1029
|
# resp.backup.source_backup_region #=> String
|
1030
|
+
# resp.backup.resource_type #=> String, one of "FILE_SYSTEM", "VOLUME"
|
1031
|
+
# resp.backup.volume.creation_time #=> Time
|
1032
|
+
# resp.backup.volume.file_system_id #=> String
|
1033
|
+
# resp.backup.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
1034
|
+
# resp.backup.volume.name #=> String
|
1035
|
+
# resp.backup.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
1036
|
+
# resp.backup.volume.ontap_configuration.junction_path #=> String
|
1037
|
+
# resp.backup.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
1038
|
+
# resp.backup.volume.ontap_configuration.size_in_megabytes #=> Integer
|
1039
|
+
# resp.backup.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
1040
|
+
# resp.backup.volume.ontap_configuration.storage_virtual_machine_id #=> String
|
1041
|
+
# resp.backup.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
1042
|
+
# resp.backup.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
1043
|
+
# resp.backup.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
1044
|
+
# resp.backup.volume.ontap_configuration.uuid #=> String
|
1045
|
+
# resp.backup.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
1046
|
+
# resp.backup.volume.resource_arn #=> String
|
1047
|
+
# resp.backup.volume.tags #=> Array
|
1048
|
+
# resp.backup.volume.tags[0].key #=> String
|
1049
|
+
# resp.backup.volume.tags[0].value #=> String
|
1050
|
+
# resp.backup.volume.volume_id #=> String
|
1051
|
+
# resp.backup.volume.volume_type #=> String, one of "ONTAP"
|
1052
|
+
# resp.backup.volume.lifecycle_transition_reason.message #=> String
|
906
1053
|
#
|
907
1054
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateBackup AWS API Documentation
|
908
1055
|
#
|
@@ -959,8 +1106,8 @@ module Aws::FSx
|
|
959
1106
|
# @option params [String] :client_request_token
|
960
1107
|
# (Optional) An idempotency token for resource creation, in a string of
|
961
1108
|
# up to 64 ASCII characters. This token is automatically filled on your
|
962
|
-
# behalf when you use the
|
963
|
-
# SDK.
|
1109
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
1110
|
+
# Services SDK.
|
964
1111
|
#
|
965
1112
|
# **A suitable default value is auto-generated.** You should normally
|
966
1113
|
# not need to pass this option.**
|
@@ -1064,15 +1211,15 @@ module Aws::FSx
|
|
1064
1211
|
# @option params [String] :client_request_token
|
1065
1212
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
1066
1213
|
# idempotent creation. This string is automatically filled on your
|
1067
|
-
# behalf when you use the
|
1068
|
-
# SDK.
|
1214
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
1215
|
+
# Services SDK.
|
1069
1216
|
#
|
1070
1217
|
# **A suitable default value is auto-generated.** You should normally
|
1071
1218
|
# not need to pass this option.**
|
1072
1219
|
#
|
1073
1220
|
# @option params [required, String] :file_system_type
|
1074
|
-
# The type of Amazon FSx file system to create
|
1075
|
-
# `LUSTRE`.
|
1221
|
+
# The type of Amazon FSx file system to create. Valid values are
|
1222
|
+
# `WINDOWS`, `LUSTRE`, and `ONTAP`.
|
1076
1223
|
#
|
1077
1224
|
# @option params [required, Integer] :storage_capacity
|
1078
1225
|
# Sets the storage capacity of the file system that you're creating.
|
@@ -1096,12 +1243,18 @@ module Aws::FSx
|
|
1096
1243
|
# * If `StorageType=HDD`, valid values are 2000 GiB - 65,536 GiB (64
|
1097
1244
|
# TiB).
|
1098
1245
|
#
|
1246
|
+
# For ONTAP file systems:
|
1247
|
+
#
|
1248
|
+
# * Valid values are 1024 GiB - 196,608 GiB (192 TiB).
|
1249
|
+
#
|
1250
|
+
# ^
|
1251
|
+
#
|
1099
1252
|
# @option params [String] :storage_type
|
1100
1253
|
# Sets the storage type for the file system you're creating. Valid
|
1101
1254
|
# values are `SSD` and `HDD`.
|
1102
1255
|
#
|
1103
1256
|
# * Set to `SSD` to use solid state drive storage. SSD is supported on
|
1104
|
-
# all Windows and
|
1257
|
+
# all Windows, Lustre, and ONTAP deployment types.
|
1105
1258
|
#
|
1106
1259
|
# * Set to `HDD` to use hard disk drive storage. HDD is supported on
|
1107
1260
|
# `SINGLE_AZ_2` and `MULTI_AZ_1` Windows file system deployment types,
|
@@ -1118,12 +1271,15 @@ module Aws::FSx
|
|
1118
1271
|
#
|
1119
1272
|
# @option params [required, Array<String>] :subnet_ids
|
1120
1273
|
# Specifies the IDs of the subnets that the file system will be
|
1121
|
-
# accessible from. For Windows `MULTI_AZ_1` file system
|
1122
|
-
# types, provide exactly two subnet IDs, one for the
|
1123
|
-
# server and one for the standby file server. You specify
|
1124
|
-
# subnets as the preferred subnet using the
|
1125
|
-
#
|
1126
|
-
#
|
1274
|
+
# accessible from. For Windows and ONTAP `MULTI_AZ_1` file system
|
1275
|
+
# deployment types, provide exactly two subnet IDs, one for the
|
1276
|
+
# preferred file server and one for the standby file server. You specify
|
1277
|
+
# one of these subnets as the preferred subnet using the
|
1278
|
+
# `WindowsConfiguration > PreferredSubnetID` or `OntapConfiguration >
|
1279
|
+
# PreferredSubnetID` properties. For more information, see [
|
1280
|
+
# Availability and durability: Single-AZ and Multi-AZ file systems][1]
|
1281
|
+
# in the *Amazon FSx for Windows User Guide* and [ Availability and
|
1282
|
+
# durability][2] in the *Amazon FSx for ONTAP User Guide*.
|
1127
1283
|
#
|
1128
1284
|
# For Windows `SINGLE_AZ_1` and `SINGLE_AZ_2` file system deployment
|
1129
1285
|
# types and Lustre file systems, provide exactly one subnet ID. The file
|
@@ -1132,6 +1288,7 @@ module Aws::FSx
|
|
1132
1288
|
#
|
1133
1289
|
#
|
1134
1290
|
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html
|
1291
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html
|
1135
1292
|
#
|
1136
1293
|
# @option params [Array<String>] :security_group_ids
|
1137
1294
|
# A list of IDs specifying the security groups to apply to all network
|
@@ -1143,14 +1300,14 @@ module Aws::FSx
|
|
1143
1300
|
# the `Name` tag appears in the console as the file system name.
|
1144
1301
|
#
|
1145
1302
|
# @option params [String] :kms_key_id
|
1146
|
-
# The ID of the
|
1147
|
-
#
|
1148
|
-
# systems
|
1149
|
-
#
|
1150
|
-
# The Amazon FSx for Lustre `SCRATCH_1`
|
1151
|
-
# always encrypted at rest using Amazon
|
1152
|
-
# information, see [Encrypt][1] in the *
|
1153
|
-
# Reference*.
|
1303
|
+
# The ID of the Key Management Service (KMS) key used to encrypt the
|
1304
|
+
# file system's data for Amazon FSx for Windows File Server file
|
1305
|
+
# systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for
|
1306
|
+
# Lustre `PERSISTENT_1` file systems at rest. If not specified, the
|
1307
|
+
# Amazon FSx managed key is used. The Amazon FSx for Lustre `SCRATCH_1`
|
1308
|
+
# and `SCRATCH_2` file systems are always encrypted at rest using Amazon
|
1309
|
+
# FSx managed keys. For more information, see [Encrypt][1] in the *Key
|
1310
|
+
# Management Service API Reference*.
|
1154
1311
|
#
|
1155
1312
|
#
|
1156
1313
|
#
|
@@ -1162,6 +1319,20 @@ module Aws::FSx
|
|
1162
1319
|
# @option params [Types::CreateFileSystemLustreConfiguration] :lustre_configuration
|
1163
1320
|
# The Lustre configuration for the file system being created.
|
1164
1321
|
#
|
1322
|
+
# @option params [Types::CreateFileSystemOntapConfiguration] :ontap_configuration
|
1323
|
+
# The ONTAP configuration properties of the FSx for NetApp ONTAP file
|
1324
|
+
# system that you are creating.
|
1325
|
+
#
|
1326
|
+
# @option params [String] :file_system_type_version
|
1327
|
+
# Sets the version of the Amazon FSx for Lustre file system you're
|
1328
|
+
# creating. Valid values are `2.10` and `2.12`.
|
1329
|
+
#
|
1330
|
+
# * Set the value to `2.10` to create a Lustre 2.10 file system.
|
1331
|
+
#
|
1332
|
+
# * Set the value to `2.12` to create a Lustre 2.12 file system.
|
1333
|
+
#
|
1334
|
+
# Default value is `2.10`.
|
1335
|
+
#
|
1165
1336
|
# @return [Types::CreateFileSystemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1166
1337
|
#
|
1167
1338
|
# * {Types::CreateFileSystemResponse#file_system #file_system} => Types::FileSystem
|
@@ -1243,7 +1414,7 @@ module Aws::FSx
|
|
1243
1414
|
#
|
1244
1415
|
# resp = client.create_file_system({
|
1245
1416
|
# client_request_token: "ClientRequestToken",
|
1246
|
-
# file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE
|
1417
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS, LUSTRE, ONTAP
|
1247
1418
|
# storage_capacity: 1, # required
|
1248
1419
|
# storage_type: "SSD", # accepts SSD, HDD
|
1249
1420
|
# subnet_ids: ["SubnetId"], # required
|
@@ -1293,6 +1464,22 @@ module Aws::FSx
|
|
1293
1464
|
# drive_cache_type: "NONE", # accepts NONE, READ
|
1294
1465
|
# data_compression_type: "NONE", # accepts NONE, LZ4
|
1295
1466
|
# },
|
1467
|
+
# ontap_configuration: {
|
1468
|
+
# automatic_backup_retention_days: 1,
|
1469
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
1470
|
+
# deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1
|
1471
|
+
# endpoint_ip_address_range: "IpAddressRange",
|
1472
|
+
# fsx_admin_password: "AdminPassword",
|
1473
|
+
# disk_iops_configuration: {
|
1474
|
+
# mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
|
1475
|
+
# iops: 1,
|
1476
|
+
# },
|
1477
|
+
# preferred_subnet_id: "SubnetId",
|
1478
|
+
# route_table_ids: ["RouteTableId"],
|
1479
|
+
# throughput_capacity: 1, # required
|
1480
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
1481
|
+
# },
|
1482
|
+
# file_system_type_version: "FileSystemTypeVersion",
|
1296
1483
|
# })
|
1297
1484
|
#
|
1298
1485
|
# @example Response structure
|
@@ -1300,7 +1487,7 @@ module Aws::FSx
|
|
1300
1487
|
# resp.file_system.owner_id #=> String
|
1301
1488
|
# resp.file_system.creation_time #=> Time
|
1302
1489
|
# resp.file_system.file_system_id #=> String
|
1303
|
-
# resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE"
|
1490
|
+
# resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP"
|
1304
1491
|
# resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
1305
1492
|
# resp.file_system.failure_details.message #=> String
|
1306
1493
|
# resp.file_system.storage_capacity #=> Integer
|
@@ -1362,6 +1549,46 @@ module Aws::FSx
|
|
1362
1549
|
# resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
1363
1550
|
# resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
1364
1551
|
# resp.file_system.administrative_actions[0].failure_details.message #=> String
|
1552
|
+
# resp.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
|
1553
|
+
# resp.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
|
1554
|
+
# resp.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
1555
|
+
# resp.file_system.administrative_actions[0].target_volume_values.name #=> String
|
1556
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
1557
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
|
1558
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
1559
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
|
1560
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
1561
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
|
1562
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
1563
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
1564
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
1565
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
|
1566
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
1567
|
+
# resp.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
|
1568
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags #=> Array
|
1569
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
|
1570
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
|
1571
|
+
# resp.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
|
1572
|
+
# resp.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP"
|
1573
|
+
# resp.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
|
1574
|
+
# resp.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
|
1575
|
+
# resp.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
|
1576
|
+
# resp.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1"
|
1577
|
+
# resp.file_system.ontap_configuration.endpoint_ip_address_range #=> String
|
1578
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
|
1579
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
|
1580
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
|
1581
|
+
# resp.file_system.ontap_configuration.endpoints.management.dns_name #=> String
|
1582
|
+
# resp.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
|
1583
|
+
# resp.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
|
1584
|
+
# resp.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
|
1585
|
+
# resp.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
|
1586
|
+
# resp.file_system.ontap_configuration.preferred_subnet_id #=> String
|
1587
|
+
# resp.file_system.ontap_configuration.route_table_ids #=> Array
|
1588
|
+
# resp.file_system.ontap_configuration.route_table_ids[0] #=> String
|
1589
|
+
# resp.file_system.ontap_configuration.throughput_capacity #=> Integer
|
1590
|
+
# resp.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
|
1591
|
+
# resp.file_system.file_system_type_version #=> String
|
1365
1592
|
#
|
1366
1593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystem AWS API Documentation
|
1367
1594
|
#
|
@@ -1372,8 +1599,8 @@ module Aws::FSx
|
|
1372
1599
|
req.send_request(options)
|
1373
1600
|
end
|
1374
1601
|
|
1375
|
-
# Creates a new Amazon FSx
|
1376
|
-
# backup.
|
1602
|
+
# Creates a new Amazon FSx for Lustre or Amazon FSx for Windows File
|
1603
|
+
# Server file system from an existing Amazon FSx backup.
|
1377
1604
|
#
|
1378
1605
|
# If a file system with the specified client request token exists and
|
1379
1606
|
# the parameters match, this operation returns the description of the
|
@@ -1415,8 +1642,8 @@ module Aws::FSx
|
|
1415
1642
|
# @option params [String] :client_request_token
|
1416
1643
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
1417
1644
|
# idempotent creation. This string is automatically filled on your
|
1418
|
-
# behalf when you use the
|
1419
|
-
# SDK.
|
1645
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
1646
|
+
# Services SDK.
|
1420
1647
|
#
|
1421
1648
|
# **A suitable default value is auto-generated.** You should normally
|
1422
1649
|
# not need to pass this option.**
|
@@ -1472,19 +1699,28 @@ module Aws::FSx
|
|
1472
1699
|
# </note>
|
1473
1700
|
#
|
1474
1701
|
# @option params [String] :kms_key_id
|
1475
|
-
# The ID of the
|
1476
|
-
#
|
1477
|
-
# systems
|
1478
|
-
#
|
1479
|
-
# The Amazon FSx for Lustre `SCRATCH_1`
|
1480
|
-
# always encrypted at rest using Amazon
|
1481
|
-
# information, see [Encrypt][1] in the *
|
1482
|
-
# Reference*.
|
1702
|
+
# The ID of the Key Management Service (KMS) key used to encrypt the
|
1703
|
+
# file system's data for Amazon FSx for Windows File Server file
|
1704
|
+
# systems, Amazon FSx for NetApp ONTAP file systems, and Amazon FSx for
|
1705
|
+
# Lustre `PERSISTENT_1` file systems at rest. If not specified, the
|
1706
|
+
# Amazon FSx managed key is used. The Amazon FSx for Lustre `SCRATCH_1`
|
1707
|
+
# and `SCRATCH_2` file systems are always encrypted at rest using Amazon
|
1708
|
+
# FSx managed keys. For more information, see [Encrypt][1] in the *Key
|
1709
|
+
# Management Service API Reference*.
|
1483
1710
|
#
|
1484
1711
|
#
|
1485
1712
|
#
|
1486
1713
|
# [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
|
1487
1714
|
#
|
1715
|
+
# @option params [String] :file_system_type_version
|
1716
|
+
# Sets the version for the Amazon FSx for Lustre file system you're
|
1717
|
+
# creating from a backup. Valid values are `2.10` and `2.12`.
|
1718
|
+
#
|
1719
|
+
# You don't need to specify `FileSystemTypeVersion` because it will be
|
1720
|
+
# applied using the backup's `FileSystemTypeVersion` setting. If you
|
1721
|
+
# choose to specify `FileSystemTypeVersion` when creating from backup,
|
1722
|
+
# the value must match the backup's `FileSystemTypeVersion` setting.
|
1723
|
+
#
|
1488
1724
|
# @return [Types::CreateFileSystemFromBackupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1489
1725
|
#
|
1490
1726
|
# * {Types::CreateFileSystemFromBackupResponse#file_system #file_system} => Types::FileSystem
|
@@ -1598,6 +1834,7 @@ module Aws::FSx
|
|
1598
1834
|
# },
|
1599
1835
|
# storage_type: "SSD", # accepts SSD, HDD
|
1600
1836
|
# kms_key_id: "KmsKeyId",
|
1837
|
+
# file_system_type_version: "FileSystemTypeVersion",
|
1601
1838
|
# })
|
1602
1839
|
#
|
1603
1840
|
# @example Response structure
|
@@ -1605,7 +1842,7 @@ module Aws::FSx
|
|
1605
1842
|
# resp.file_system.owner_id #=> String
|
1606
1843
|
# resp.file_system.creation_time #=> Time
|
1607
1844
|
# resp.file_system.file_system_id #=> String
|
1608
|
-
# resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE"
|
1845
|
+
# resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP"
|
1609
1846
|
# resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
1610
1847
|
# resp.file_system.failure_details.message #=> String
|
1611
1848
|
# resp.file_system.storage_capacity #=> Integer
|
@@ -1667,6 +1904,46 @@ module Aws::FSx
|
|
1667
1904
|
# resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
1668
1905
|
# resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
1669
1906
|
# resp.file_system.administrative_actions[0].failure_details.message #=> String
|
1907
|
+
# resp.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
|
1908
|
+
# resp.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
|
1909
|
+
# resp.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
1910
|
+
# resp.file_system.administrative_actions[0].target_volume_values.name #=> String
|
1911
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
1912
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
|
1913
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
1914
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
|
1915
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
1916
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
|
1917
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
1918
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
1919
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
1920
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
|
1921
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
1922
|
+
# resp.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
|
1923
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags #=> Array
|
1924
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
|
1925
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
|
1926
|
+
# resp.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
|
1927
|
+
# resp.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP"
|
1928
|
+
# resp.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
|
1929
|
+
# resp.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
|
1930
|
+
# resp.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
|
1931
|
+
# resp.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1"
|
1932
|
+
# resp.file_system.ontap_configuration.endpoint_ip_address_range #=> String
|
1933
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
|
1934
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
|
1935
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
|
1936
|
+
# resp.file_system.ontap_configuration.endpoints.management.dns_name #=> String
|
1937
|
+
# resp.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
|
1938
|
+
# resp.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
|
1939
|
+
# resp.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
|
1940
|
+
# resp.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
|
1941
|
+
# resp.file_system.ontap_configuration.preferred_subnet_id #=> String
|
1942
|
+
# resp.file_system.ontap_configuration.route_table_ids #=> Array
|
1943
|
+
# resp.file_system.ontap_configuration.route_table_ids[0] #=> String
|
1944
|
+
# resp.file_system.ontap_configuration.throughput_capacity #=> Integer
|
1945
|
+
# resp.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
|
1946
|
+
# resp.file_system.file_system_type_version #=> String
|
1670
1947
|
#
|
1671
1948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemFromBackup AWS API Documentation
|
1672
1949
|
#
|
@@ -1677,6 +1954,302 @@ module Aws::FSx
|
|
1677
1954
|
req.send_request(options)
|
1678
1955
|
end
|
1679
1956
|
|
1957
|
+
# Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP
|
1958
|
+
# file system.
|
1959
|
+
#
|
1960
|
+
# @option params [Types::CreateSvmActiveDirectoryConfiguration] :active_directory_configuration
|
1961
|
+
# Describes the self-managed Microsoft Active Directory to which you
|
1962
|
+
# want to join the SVM. Joining an Active Directory provides user
|
1963
|
+
# authentication and access control for SMB clients, including Microsoft
|
1964
|
+
# Windows and macOS client accessing the file system.
|
1965
|
+
#
|
1966
|
+
# @option params [String] :client_request_token
|
1967
|
+
# (Optional) An idempotency token for resource creation, in a string of
|
1968
|
+
# up to 64 ASCII characters. This token is automatically filled on your
|
1969
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
1970
|
+
# Services SDK.
|
1971
|
+
#
|
1972
|
+
# **A suitable default value is auto-generated.** You should normally
|
1973
|
+
# not need to pass this option.**
|
1974
|
+
#
|
1975
|
+
# @option params [required, String] :file_system_id
|
1976
|
+
# The globally unique ID of the file system, assigned by Amazon FSx.
|
1977
|
+
#
|
1978
|
+
# @option params [required, String] :name
|
1979
|
+
# The name of the SVM.
|
1980
|
+
#
|
1981
|
+
# @option params [String] :svm_admin_password
|
1982
|
+
# The password to use when managing the SVM using the NetApp ONTAP CLI
|
1983
|
+
# or REST API. If you do not specify a password, you can still use the
|
1984
|
+
# file system's `fsxadmin` user to manage the SVM.
|
1985
|
+
#
|
1986
|
+
# @option params [Array<Types::Tag>] :tags
|
1987
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
1988
|
+
#
|
1989
|
+
# @option params [String] :root_volume_security_style
|
1990
|
+
# The security style of the root volume of the SVM. Specify one of the
|
1991
|
+
# following values:
|
1992
|
+
#
|
1993
|
+
# * `UNIX` if the file system is managed by a UNIX administrator, the
|
1994
|
+
# majority of users are NFS clients, and an application accessing the
|
1995
|
+
# data uses a UNIX user as the service account.
|
1996
|
+
#
|
1997
|
+
# * `NTFS` if the file system is managed by a Windows administrator, the
|
1998
|
+
# majority of users are SMB clients, and an application accessing the
|
1999
|
+
# data uses a Windows user as the service account.
|
2000
|
+
#
|
2001
|
+
# * `MIXED` if the file system is managed by both UNIX and Windows
|
2002
|
+
# administrators and users consist of both NFS and SMB clients.
|
2003
|
+
#
|
2004
|
+
# @return [Types::CreateStorageVirtualMachineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2005
|
+
#
|
2006
|
+
# * {Types::CreateStorageVirtualMachineResponse#storage_virtual_machine #storage_virtual_machine} => Types::StorageVirtualMachine
|
2007
|
+
#
|
2008
|
+
# @example Request syntax with placeholder values
|
2009
|
+
#
|
2010
|
+
# resp = client.create_storage_virtual_machine({
|
2011
|
+
# active_directory_configuration: {
|
2012
|
+
# net_bios_name: "NetBiosAlias", # required
|
2013
|
+
# self_managed_active_directory_configuration: {
|
2014
|
+
# domain_name: "ActiveDirectoryFullyQualifiedName", # required
|
2015
|
+
# organizational_unit_distinguished_name: "OrganizationalUnitDistinguishedName",
|
2016
|
+
# file_system_administrators_group: "FileSystemAdministratorsGroupName",
|
2017
|
+
# user_name: "DirectoryUserName", # required
|
2018
|
+
# password: "DirectoryPassword", # required
|
2019
|
+
# dns_ips: ["IpAddress"], # required
|
2020
|
+
# },
|
2021
|
+
# },
|
2022
|
+
# client_request_token: "ClientRequestToken",
|
2023
|
+
# file_system_id: "FileSystemId", # required
|
2024
|
+
# name: "StorageVirtualMachineName", # required
|
2025
|
+
# svm_admin_password: "AdminPassword",
|
2026
|
+
# tags: [
|
2027
|
+
# {
|
2028
|
+
# key: "TagKey", # required
|
2029
|
+
# value: "TagValue", # required
|
2030
|
+
# },
|
2031
|
+
# ],
|
2032
|
+
# root_volume_security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
2033
|
+
# })
|
2034
|
+
#
|
2035
|
+
# @example Response structure
|
2036
|
+
#
|
2037
|
+
# resp.storage_virtual_machine.active_directory_configuration.net_bios_name #=> String
|
2038
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.domain_name #=> String
|
2039
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
|
2040
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
|
2041
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.user_name #=> String
|
2042
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
2043
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
2044
|
+
# resp.storage_virtual_machine.creation_time #=> Time
|
2045
|
+
# resp.storage_virtual_machine.endpoints.iscsi.dns_name #=> String
|
2046
|
+
# resp.storage_virtual_machine.endpoints.iscsi.ip_addresses #=> Array
|
2047
|
+
# resp.storage_virtual_machine.endpoints.iscsi.ip_addresses[0] #=> String
|
2048
|
+
# resp.storage_virtual_machine.endpoints.management.dns_name #=> String
|
2049
|
+
# resp.storage_virtual_machine.endpoints.management.ip_addresses #=> Array
|
2050
|
+
# resp.storage_virtual_machine.endpoints.management.ip_addresses[0] #=> String
|
2051
|
+
# resp.storage_virtual_machine.endpoints.nfs.dns_name #=> String
|
2052
|
+
# resp.storage_virtual_machine.endpoints.nfs.ip_addresses #=> Array
|
2053
|
+
# resp.storage_virtual_machine.endpoints.nfs.ip_addresses[0] #=> String
|
2054
|
+
# resp.storage_virtual_machine.endpoints.smb.dns_name #=> String
|
2055
|
+
# resp.storage_virtual_machine.endpoints.smb.ip_addresses #=> Array
|
2056
|
+
# resp.storage_virtual_machine.endpoints.smb.ip_addresses[0] #=> String
|
2057
|
+
# resp.storage_virtual_machine.file_system_id #=> String
|
2058
|
+
# resp.storage_virtual_machine.lifecycle #=> String, one of "CREATED", "CREATING", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
2059
|
+
# resp.storage_virtual_machine.name #=> String
|
2060
|
+
# resp.storage_virtual_machine.resource_arn #=> String
|
2061
|
+
# resp.storage_virtual_machine.storage_virtual_machine_id #=> String
|
2062
|
+
# resp.storage_virtual_machine.subtype #=> String, one of "DEFAULT", "DP_DESTINATION", "SYNC_DESTINATION", "SYNC_SOURCE"
|
2063
|
+
# resp.storage_virtual_machine.uuid #=> String
|
2064
|
+
# resp.storage_virtual_machine.tags #=> Array
|
2065
|
+
# resp.storage_virtual_machine.tags[0].key #=> String
|
2066
|
+
# resp.storage_virtual_machine.tags[0].value #=> String
|
2067
|
+
# resp.storage_virtual_machine.lifecycle_transition_reason.message #=> String
|
2068
|
+
# resp.storage_virtual_machine.root_volume_security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
2069
|
+
#
|
2070
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateStorageVirtualMachine AWS API Documentation
|
2071
|
+
#
|
2072
|
+
# @overload create_storage_virtual_machine(params = {})
|
2073
|
+
# @param [Hash] params ({})
|
2074
|
+
def create_storage_virtual_machine(params = {}, options = {})
|
2075
|
+
req = build_request(:create_storage_virtual_machine, params)
|
2076
|
+
req.send_request(options)
|
2077
|
+
end
|
2078
|
+
|
2079
|
+
# Creates an Amazon FSx for NetApp ONTAP storage volume.
|
2080
|
+
#
|
2081
|
+
# @option params [String] :client_request_token
|
2082
|
+
# (Optional) An idempotency token for resource creation, in a string of
|
2083
|
+
# up to 64 ASCII characters. This token is automatically filled on your
|
2084
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
2085
|
+
# Services SDK.
|
2086
|
+
#
|
2087
|
+
# **A suitable default value is auto-generated.** You should normally
|
2088
|
+
# not need to pass this option.**
|
2089
|
+
#
|
2090
|
+
# @option params [required, String] :volume_type
|
2091
|
+
# Specifies the type of volume to create; `ONTAP` is the only valid
|
2092
|
+
# volume type.
|
2093
|
+
#
|
2094
|
+
# @option params [required, String] :name
|
2095
|
+
# Specifies the name of the volume you're creating.
|
2096
|
+
#
|
2097
|
+
# @option params [Types::CreateOntapVolumeConfiguration] :ontap_configuration
|
2098
|
+
# Specifies the `ONTAP` configuration to use in creating the volume.
|
2099
|
+
#
|
2100
|
+
# @option params [Array<Types::Tag>] :tags
|
2101
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
2102
|
+
#
|
2103
|
+
# @return [Types::CreateVolumeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2104
|
+
#
|
2105
|
+
# * {Types::CreateVolumeResponse#volume #volume} => Types::Volume
|
2106
|
+
#
|
2107
|
+
# @example Request syntax with placeholder values
|
2108
|
+
#
|
2109
|
+
# resp = client.create_volume({
|
2110
|
+
# client_request_token: "ClientRequestToken",
|
2111
|
+
# volume_type: "ONTAP", # required, accepts ONTAP
|
2112
|
+
# name: "VolumeName", # required
|
2113
|
+
# ontap_configuration: {
|
2114
|
+
# junction_path: "JunctionPath", # required
|
2115
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
2116
|
+
# size_in_megabytes: 1, # required
|
2117
|
+
# storage_efficiency_enabled: false, # required
|
2118
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
2119
|
+
# tiering_policy: {
|
2120
|
+
# cooling_period: 1,
|
2121
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
2122
|
+
# },
|
2123
|
+
# },
|
2124
|
+
# tags: [
|
2125
|
+
# {
|
2126
|
+
# key: "TagKey", # required
|
2127
|
+
# value: "TagValue", # required
|
2128
|
+
# },
|
2129
|
+
# ],
|
2130
|
+
# })
|
2131
|
+
#
|
2132
|
+
# @example Response structure
|
2133
|
+
#
|
2134
|
+
# resp.volume.creation_time #=> Time
|
2135
|
+
# resp.volume.file_system_id #=> String
|
2136
|
+
# resp.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
2137
|
+
# resp.volume.name #=> String
|
2138
|
+
# resp.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
2139
|
+
# resp.volume.ontap_configuration.junction_path #=> String
|
2140
|
+
# resp.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
2141
|
+
# resp.volume.ontap_configuration.size_in_megabytes #=> Integer
|
2142
|
+
# resp.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
2143
|
+
# resp.volume.ontap_configuration.storage_virtual_machine_id #=> String
|
2144
|
+
# resp.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
2145
|
+
# resp.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
2146
|
+
# resp.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
2147
|
+
# resp.volume.ontap_configuration.uuid #=> String
|
2148
|
+
# resp.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
2149
|
+
# resp.volume.resource_arn #=> String
|
2150
|
+
# resp.volume.tags #=> Array
|
2151
|
+
# resp.volume.tags[0].key #=> String
|
2152
|
+
# resp.volume.tags[0].value #=> String
|
2153
|
+
# resp.volume.volume_id #=> String
|
2154
|
+
# resp.volume.volume_type #=> String, one of "ONTAP"
|
2155
|
+
# resp.volume.lifecycle_transition_reason.message #=> String
|
2156
|
+
#
|
2157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolume AWS API Documentation
|
2158
|
+
#
|
2159
|
+
# @overload create_volume(params = {})
|
2160
|
+
# @param [Hash] params ({})
|
2161
|
+
def create_volume(params = {}, options = {})
|
2162
|
+
req = build_request(:create_volume, params)
|
2163
|
+
req.send_request(options)
|
2164
|
+
end
|
2165
|
+
|
2166
|
+
# Creates a new Amazon FSx for NetApp ONTAP volume from an existing
|
2167
|
+
# Amazon FSx volume backup.
|
2168
|
+
#
|
2169
|
+
# @option params [required, String] :backup_id
|
2170
|
+
# The ID of the source backup. Specifies the backup you are copying.
|
2171
|
+
#
|
2172
|
+
# @option params [String] :client_request_token
|
2173
|
+
# (Optional) An idempotency token for resource creation, in a string of
|
2174
|
+
# up to 64 ASCII characters. This token is automatically filled on your
|
2175
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
2176
|
+
# Services SDK.
|
2177
|
+
#
|
2178
|
+
# **A suitable default value is auto-generated.** You should normally
|
2179
|
+
# not need to pass this option.**
|
2180
|
+
#
|
2181
|
+
# @option params [required, String] :name
|
2182
|
+
# The name of the new volume you're creating.
|
2183
|
+
#
|
2184
|
+
# @option params [Types::CreateOntapVolumeConfiguration] :ontap_configuration
|
2185
|
+
# Specifies the configuration of the ONTAP volume that you are creating.
|
2186
|
+
#
|
2187
|
+
# @option params [Array<Types::Tag>] :tags
|
2188
|
+
# A list of `Tag` values, with a maximum of 50 elements.
|
2189
|
+
#
|
2190
|
+
# @return [Types::CreateVolumeFromBackupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2191
|
+
#
|
2192
|
+
# * {Types::CreateVolumeFromBackupResponse#volume #volume} => Types::Volume
|
2193
|
+
#
|
2194
|
+
# @example Request syntax with placeholder values
|
2195
|
+
#
|
2196
|
+
# resp = client.create_volume_from_backup({
|
2197
|
+
# backup_id: "BackupId", # required
|
2198
|
+
# client_request_token: "ClientRequestToken",
|
2199
|
+
# name: "VolumeName", # required
|
2200
|
+
# ontap_configuration: {
|
2201
|
+
# junction_path: "JunctionPath", # required
|
2202
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
2203
|
+
# size_in_megabytes: 1, # required
|
2204
|
+
# storage_efficiency_enabled: false, # required
|
2205
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
2206
|
+
# tiering_policy: {
|
2207
|
+
# cooling_period: 1,
|
2208
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
2209
|
+
# },
|
2210
|
+
# },
|
2211
|
+
# tags: [
|
2212
|
+
# {
|
2213
|
+
# key: "TagKey", # required
|
2214
|
+
# value: "TagValue", # required
|
2215
|
+
# },
|
2216
|
+
# ],
|
2217
|
+
# })
|
2218
|
+
#
|
2219
|
+
# @example Response structure
|
2220
|
+
#
|
2221
|
+
# resp.volume.creation_time #=> Time
|
2222
|
+
# resp.volume.file_system_id #=> String
|
2223
|
+
# resp.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
2224
|
+
# resp.volume.name #=> String
|
2225
|
+
# resp.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
2226
|
+
# resp.volume.ontap_configuration.junction_path #=> String
|
2227
|
+
# resp.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
2228
|
+
# resp.volume.ontap_configuration.size_in_megabytes #=> Integer
|
2229
|
+
# resp.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
2230
|
+
# resp.volume.ontap_configuration.storage_virtual_machine_id #=> String
|
2231
|
+
# resp.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
2232
|
+
# resp.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
2233
|
+
# resp.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
2234
|
+
# resp.volume.ontap_configuration.uuid #=> String
|
2235
|
+
# resp.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
2236
|
+
# resp.volume.resource_arn #=> String
|
2237
|
+
# resp.volume.tags #=> Array
|
2238
|
+
# resp.volume.tags[0].key #=> String
|
2239
|
+
# resp.volume.tags[0].value #=> String
|
2240
|
+
# resp.volume.volume_id #=> String
|
2241
|
+
# resp.volume.volume_type #=> String, one of "ONTAP"
|
2242
|
+
# resp.volume.lifecycle_transition_reason.message #=> String
|
2243
|
+
#
|
2244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateVolumeFromBackup AWS API Documentation
|
2245
|
+
#
|
2246
|
+
# @overload create_volume_from_backup(params = {})
|
2247
|
+
# @param [Hash] params ({})
|
2248
|
+
def create_volume_from_backup(params = {}, options = {})
|
2249
|
+
req = build_request(:create_volume_from_backup, params)
|
2250
|
+
req.send_request(options)
|
2251
|
+
end
|
2252
|
+
|
1680
2253
|
# Deletes an Amazon FSx backup, deleting its contents. After deletion,
|
1681
2254
|
# the backup no longer exists, and its data is gone.
|
1682
2255
|
#
|
@@ -1692,7 +2265,7 @@ module Aws::FSx
|
|
1692
2265
|
# @option params [String] :client_request_token
|
1693
2266
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
1694
2267
|
# idempotent deletion. This is automatically filled on your behalf when
|
1695
|
-
# using the
|
2268
|
+
# using the CLI or SDK.
|
1696
2269
|
#
|
1697
2270
|
# **A suitable default value is auto-generated.** You should normally
|
1698
2271
|
# not need to pass this option.**
|
@@ -1742,6 +2315,10 @@ module Aws::FSx
|
|
1742
2315
|
# system no longer exists, and its data is gone. Any existing automatic
|
1743
2316
|
# backups will also be deleted.
|
1744
2317
|
#
|
2318
|
+
# To delete an Amazon FSx for NetApp ONTAP file system, first delete all
|
2319
|
+
# the volumes and SVMs on the file system. Then provide a `FileSystemId`
|
2320
|
+
# value to the `DeleFileSystem` operation.
|
2321
|
+
#
|
1745
2322
|
# By default, when you delete an Amazon FSx for Windows File Server file
|
1746
2323
|
# system, a final backup is created upon deletion. This final backup is
|
1747
2324
|
# not subject to the file system's retention policy, and must be
|
@@ -1769,7 +2346,7 @@ module Aws::FSx
|
|
1769
2346
|
# @option params [String] :client_request_token
|
1770
2347
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
1771
2348
|
# idempotent deletion. This is automatically filled on your behalf when
|
1772
|
-
# using the
|
2349
|
+
# using the Command Line Interface (CLI) or an Amazon Web Services SDK.
|
1773
2350
|
#
|
1774
2351
|
# **A suitable default value is auto-generated.** You should normally
|
1775
2352
|
# not need to pass this option.**
|
@@ -1851,10 +2428,114 @@ module Aws::FSx
|
|
1851
2428
|
req.send_request(options)
|
1852
2429
|
end
|
1853
2430
|
|
2431
|
+
# Deletes an existing Amazon FSx for ONTAP storage virtual machine
|
2432
|
+
# (SVM). Prior to deleting an SVM, you must delete all non-root volumes
|
2433
|
+
# in the SVM, otherwise the operation will fail.
|
2434
|
+
#
|
2435
|
+
# @option params [String] :client_request_token
|
2436
|
+
# (Optional) An idempotency token for resource creation, in a string of
|
2437
|
+
# up to 64 ASCII characters. This token is automatically filled on your
|
2438
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
2439
|
+
# Services SDK.
|
2440
|
+
#
|
2441
|
+
# **A suitable default value is auto-generated.** You should normally
|
2442
|
+
# not need to pass this option.**
|
2443
|
+
#
|
2444
|
+
# @option params [required, String] :storage_virtual_machine_id
|
2445
|
+
# The ID of the SVM that you want to delete.
|
2446
|
+
#
|
2447
|
+
# @return [Types::DeleteStorageVirtualMachineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2448
|
+
#
|
2449
|
+
# * {Types::DeleteStorageVirtualMachineResponse#storage_virtual_machine_id #storage_virtual_machine_id} => String
|
2450
|
+
# * {Types::DeleteStorageVirtualMachineResponse#lifecycle #lifecycle} => String
|
2451
|
+
#
|
2452
|
+
# @example Request syntax with placeholder values
|
2453
|
+
#
|
2454
|
+
# resp = client.delete_storage_virtual_machine({
|
2455
|
+
# client_request_token: "ClientRequestToken",
|
2456
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
2457
|
+
# })
|
2458
|
+
#
|
2459
|
+
# @example Response structure
|
2460
|
+
#
|
2461
|
+
# resp.storage_virtual_machine_id #=> String
|
2462
|
+
# resp.lifecycle #=> String, one of "CREATED", "CREATING", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
2463
|
+
#
|
2464
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteStorageVirtualMachine AWS API Documentation
|
2465
|
+
#
|
2466
|
+
# @overload delete_storage_virtual_machine(params = {})
|
2467
|
+
# @param [Hash] params ({})
|
2468
|
+
def delete_storage_virtual_machine(params = {}, options = {})
|
2469
|
+
req = build_request(:delete_storage_virtual_machine, params)
|
2470
|
+
req.send_request(options)
|
2471
|
+
end
|
2472
|
+
|
2473
|
+
# Deletes an Amazon FSx for NetApp ONTAP volume. When deleting a volume,
|
2474
|
+
# you have the option of creating a final backup. If you create a final
|
2475
|
+
# backup, you have the option to apply Tags to the backup. You need to
|
2476
|
+
# have `fsx:TagResource` permission in order to apply tags to the
|
2477
|
+
# backup.
|
2478
|
+
#
|
2479
|
+
# @option params [String] :client_request_token
|
2480
|
+
# (Optional) An idempotency token for resource creation, in a string of
|
2481
|
+
# up to 64 ASCII characters. This token is automatically filled on your
|
2482
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
2483
|
+
# Services SDK.
|
2484
|
+
#
|
2485
|
+
# **A suitable default value is auto-generated.** You should normally
|
2486
|
+
# not need to pass this option.**
|
2487
|
+
#
|
2488
|
+
# @option params [required, String] :volume_id
|
2489
|
+
# The ID of the volume you are deleting.
|
2490
|
+
#
|
2491
|
+
# @option params [Types::DeleteVolumeOntapConfiguration] :ontap_configuration
|
2492
|
+
# For Amazon FSx for ONTAP volumes, specify whether to take a final
|
2493
|
+
# backup of the volume, and apply tags to the backup.
|
2494
|
+
#
|
2495
|
+
# @return [Types::DeleteVolumeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2496
|
+
#
|
2497
|
+
# * {Types::DeleteVolumeResponse#volume_id #volume_id} => String
|
2498
|
+
# * {Types::DeleteVolumeResponse#lifecycle #lifecycle} => String
|
2499
|
+
# * {Types::DeleteVolumeResponse#ontap_response #ontap_response} => Types::DeleteVolumeOntapResponse
|
2500
|
+
#
|
2501
|
+
# @example Request syntax with placeholder values
|
2502
|
+
#
|
2503
|
+
# resp = client.delete_volume({
|
2504
|
+
# client_request_token: "ClientRequestToken",
|
2505
|
+
# volume_id: "VolumeId", # required
|
2506
|
+
# ontap_configuration: {
|
2507
|
+
# skip_final_backup: false,
|
2508
|
+
# final_backup_tags: [
|
2509
|
+
# {
|
2510
|
+
# key: "TagKey", # required
|
2511
|
+
# value: "TagValue", # required
|
2512
|
+
# },
|
2513
|
+
# ],
|
2514
|
+
# },
|
2515
|
+
# })
|
2516
|
+
#
|
2517
|
+
# @example Response structure
|
2518
|
+
#
|
2519
|
+
# resp.volume_id #=> String
|
2520
|
+
# resp.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
2521
|
+
# resp.ontap_response.final_backup_id #=> String
|
2522
|
+
# resp.ontap_response.final_backup_tags #=> Array
|
2523
|
+
# resp.ontap_response.final_backup_tags[0].key #=> String
|
2524
|
+
# resp.ontap_response.final_backup_tags[0].value #=> String
|
2525
|
+
#
|
2526
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolume AWS API Documentation
|
2527
|
+
#
|
2528
|
+
# @overload delete_volume(params = {})
|
2529
|
+
# @param [Hash] params ({})
|
2530
|
+
def delete_volume(params = {}, options = {})
|
2531
|
+
req = build_request(:delete_volume, params)
|
2532
|
+
req.send_request(options)
|
2533
|
+
end
|
2534
|
+
|
1854
2535
|
# Returns the description of specific Amazon FSx backups, if a
|
1855
2536
|
# `BackupIds` value is provided for that backup. Otherwise, it returns
|
1856
|
-
# all backups owned by your
|
1857
|
-
# endpoint that you're calling.
|
2537
|
+
# all backups owned by your Amazon Web Services account in the Amazon
|
2538
|
+
# Web Services Region of the endpoint that you're calling.
|
1858
2539
|
#
|
1859
2540
|
# When retrieving all backups, you can optionally specify the
|
1860
2541
|
# `MaxResults` parameter to limit the number of backups in a response.
|
@@ -1871,7 +2552,7 @@ module Aws::FSx
|
|
1871
2552
|
#
|
1872
2553
|
# When using this action, keep the following in mind:
|
1873
2554
|
#
|
1874
|
-
# * The implementation might return fewer than `MaxResults`
|
2555
|
+
# * The implementation might return fewer than `MaxResults` backup
|
1875
2556
|
# descriptions while still including a `NextToken` value.
|
1876
2557
|
#
|
1877
2558
|
# * The order of backups returned in the response of one
|
@@ -1883,7 +2564,8 @@ module Aws::FSx
|
|
1883
2564
|
# filters. If any IDs are not found, BackupNotFound will be thrown.
|
1884
2565
|
#
|
1885
2566
|
# @option params [Array<Types::Filter>] :filters
|
1886
|
-
# Filters structure. Supported names are file-system-id
|
2567
|
+
# Filters structure. Supported names are `file-system-id`,
|
2568
|
+
# `backup-type`, `file-system-type`, and `volume-id`.
|
1887
2569
|
#
|
1888
2570
|
# @option params [Integer] :max_results
|
1889
2571
|
# Maximum number of backups to return in the response (integer). This
|
@@ -1948,7 +2630,7 @@ module Aws::FSx
|
|
1948
2630
|
# backup_ids: ["BackupId"],
|
1949
2631
|
# filters: [
|
1950
2632
|
# {
|
1951
|
-
# name: "file-system-id", # accepts file-system-id, backup-type, file-system-type
|
2633
|
+
# name: "file-system-id", # accepts file-system-id, backup-type, file-system-type, volume-id
|
1952
2634
|
# values: ["FilterValue"],
|
1953
2635
|
# },
|
1954
2636
|
# ],
|
@@ -1973,7 +2655,7 @@ module Aws::FSx
|
|
1973
2655
|
# resp.backups[0].file_system.owner_id #=> String
|
1974
2656
|
# resp.backups[0].file_system.creation_time #=> Time
|
1975
2657
|
# resp.backups[0].file_system.file_system_id #=> String
|
1976
|
-
# resp.backups[0].file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE"
|
2658
|
+
# resp.backups[0].file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP"
|
1977
2659
|
# resp.backups[0].file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
1978
2660
|
# resp.backups[0].file_system.failure_details.message #=> String
|
1979
2661
|
# resp.backups[0].file_system.storage_capacity #=> Integer
|
@@ -2035,12 +2717,75 @@ module Aws::FSx
|
|
2035
2717
|
# resp.backups[0].file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
2036
2718
|
# resp.backups[0].file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
2037
2719
|
# resp.backups[0].file_system.administrative_actions[0].failure_details.message #=> String
|
2720
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
|
2721
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
|
2722
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
2723
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.name #=> String
|
2724
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
2725
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
|
2726
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
2727
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
|
2728
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
2729
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
|
2730
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
2731
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
2732
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
2733
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
|
2734
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
2735
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
|
2736
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.tags #=> Array
|
2737
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
|
2738
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
|
2739
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.volume_id #=> String
|
2740
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP"
|
2741
|
+
# resp.backups[0].file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
|
2742
|
+
# resp.backups[0].file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
|
2743
|
+
# resp.backups[0].file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
|
2744
|
+
# resp.backups[0].file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1"
|
2745
|
+
# resp.backups[0].file_system.ontap_configuration.endpoint_ip_address_range #=> String
|
2746
|
+
# resp.backups[0].file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
|
2747
|
+
# resp.backups[0].file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
|
2748
|
+
# resp.backups[0].file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
|
2749
|
+
# resp.backups[0].file_system.ontap_configuration.endpoints.management.dns_name #=> String
|
2750
|
+
# resp.backups[0].file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
|
2751
|
+
# resp.backups[0].file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
|
2752
|
+
# resp.backups[0].file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
|
2753
|
+
# resp.backups[0].file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
|
2754
|
+
# resp.backups[0].file_system.ontap_configuration.preferred_subnet_id #=> String
|
2755
|
+
# resp.backups[0].file_system.ontap_configuration.route_table_ids #=> Array
|
2756
|
+
# resp.backups[0].file_system.ontap_configuration.route_table_ids[0] #=> String
|
2757
|
+
# resp.backups[0].file_system.ontap_configuration.throughput_capacity #=> Integer
|
2758
|
+
# resp.backups[0].file_system.ontap_configuration.weekly_maintenance_start_time #=> String
|
2759
|
+
# resp.backups[0].file_system.file_system_type_version #=> String
|
2038
2760
|
# resp.backups[0].directory_information.domain_name #=> String
|
2039
2761
|
# resp.backups[0].directory_information.active_directory_id #=> String
|
2040
2762
|
# resp.backups[0].directory_information.resource_arn #=> String
|
2041
2763
|
# resp.backups[0].owner_id #=> String
|
2042
2764
|
# resp.backups[0].source_backup_id #=> String
|
2043
2765
|
# resp.backups[0].source_backup_region #=> String
|
2766
|
+
# resp.backups[0].resource_type #=> String, one of "FILE_SYSTEM", "VOLUME"
|
2767
|
+
# resp.backups[0].volume.creation_time #=> Time
|
2768
|
+
# resp.backups[0].volume.file_system_id #=> String
|
2769
|
+
# resp.backups[0].volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
2770
|
+
# resp.backups[0].volume.name #=> String
|
2771
|
+
# resp.backups[0].volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
2772
|
+
# resp.backups[0].volume.ontap_configuration.junction_path #=> String
|
2773
|
+
# resp.backups[0].volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
2774
|
+
# resp.backups[0].volume.ontap_configuration.size_in_megabytes #=> Integer
|
2775
|
+
# resp.backups[0].volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
2776
|
+
# resp.backups[0].volume.ontap_configuration.storage_virtual_machine_id #=> String
|
2777
|
+
# resp.backups[0].volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
2778
|
+
# resp.backups[0].volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
2779
|
+
# resp.backups[0].volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
2780
|
+
# resp.backups[0].volume.ontap_configuration.uuid #=> String
|
2781
|
+
# resp.backups[0].volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
2782
|
+
# resp.backups[0].volume.resource_arn #=> String
|
2783
|
+
# resp.backups[0].volume.tags #=> Array
|
2784
|
+
# resp.backups[0].volume.tags[0].key #=> String
|
2785
|
+
# resp.backups[0].volume.tags[0].value #=> String
|
2786
|
+
# resp.backups[0].volume.volume_id #=> String
|
2787
|
+
# resp.backups[0].volume.volume_type #=> String, one of "ONTAP"
|
2788
|
+
# resp.backups[0].volume.lifecycle_transition_reason.message #=> String
|
2044
2789
|
# resp.next_token #=> String
|
2045
2790
|
#
|
2046
2791
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeBackups AWS API Documentation
|
@@ -2057,8 +2802,8 @@ module Aws::FSx
|
|
2057
2802
|
# request, or if filters are used in the request. You can use filters to
|
2058
2803
|
# narrow the response to include just tasks for specific file systems,
|
2059
2804
|
# or tasks in a specific lifecycle state. Otherwise, it returns all data
|
2060
|
-
# repository tasks owned by your
|
2061
|
-
# endpoint that you're calling.
|
2805
|
+
# repository tasks owned by your Amazon Web Services account in the
|
2806
|
+
# Amazon Web Services Region of the endpoint that you're calling.
|
2062
2807
|
#
|
2063
2808
|
# When retrieving all tasks, you can paginate the response by using the
|
2064
2809
|
# optional `MaxResults` parameter to limit the number of tasks returned
|
@@ -2152,8 +2897,8 @@ module Aws::FSx
|
|
2152
2897
|
# @option params [String] :client_request_token
|
2153
2898
|
# (Optional) An idempotency token for resource creation, in a string of
|
2154
2899
|
# up to 64 ASCII characters. This token is automatically filled on your
|
2155
|
-
# behalf when you use the
|
2156
|
-
# SDK.
|
2900
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
2901
|
+
# Services SDK.
|
2157
2902
|
#
|
2158
2903
|
# **A suitable default value is auto-generated.** You should normally
|
2159
2904
|
# not need to pass this option.**
|
@@ -2209,8 +2954,9 @@ module Aws::FSx
|
|
2209
2954
|
|
2210
2955
|
# Returns the description of specific Amazon FSx file systems, if a
|
2211
2956
|
# `FileSystemIds` value is provided for that file system. Otherwise, it
|
2212
|
-
# returns descriptions of all file systems owned by your
|
2213
|
-
# the
|
2957
|
+
# returns descriptions of all file systems owned by your Amazon Web
|
2958
|
+
# Services account in the Amazon Web Services Region of the endpoint
|
2959
|
+
# that you're calling.
|
2214
2960
|
#
|
2215
2961
|
# When retrieving all file system descriptions, you can optionally
|
2216
2962
|
# specify the `MaxResults` parameter to limit the number of descriptions
|
@@ -2315,7 +3061,7 @@ module Aws::FSx
|
|
2315
3061
|
# resp.file_systems[0].owner_id #=> String
|
2316
3062
|
# resp.file_systems[0].creation_time #=> Time
|
2317
3063
|
# resp.file_systems[0].file_system_id #=> String
|
2318
|
-
# resp.file_systems[0].file_system_type #=> String, one of "WINDOWS", "LUSTRE"
|
3064
|
+
# resp.file_systems[0].file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP"
|
2319
3065
|
# resp.file_systems[0].lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
2320
3066
|
# resp.file_systems[0].failure_details.message #=> String
|
2321
3067
|
# resp.file_systems[0].storage_capacity #=> Integer
|
@@ -2377,6 +3123,46 @@ module Aws::FSx
|
|
2377
3123
|
# resp.file_systems[0].administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
2378
3124
|
# resp.file_systems[0].administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
2379
3125
|
# resp.file_systems[0].administrative_actions[0].failure_details.message #=> String
|
3126
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.creation_time #=> Time
|
3127
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.file_system_id #=> String
|
3128
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
3129
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.name #=> String
|
3130
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
3131
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
|
3132
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
3133
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
|
3134
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
3135
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
|
3136
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
3137
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
3138
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
3139
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
|
3140
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
3141
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.resource_arn #=> String
|
3142
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.tags #=> Array
|
3143
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.tags[0].key #=> String
|
3144
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.tags[0].value #=> String
|
3145
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.volume_id #=> String
|
3146
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP"
|
3147
|
+
# resp.file_systems[0].administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
|
3148
|
+
# resp.file_systems[0].ontap_configuration.automatic_backup_retention_days #=> Integer
|
3149
|
+
# resp.file_systems[0].ontap_configuration.daily_automatic_backup_start_time #=> String
|
3150
|
+
# resp.file_systems[0].ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1"
|
3151
|
+
# resp.file_systems[0].ontap_configuration.endpoint_ip_address_range #=> String
|
3152
|
+
# resp.file_systems[0].ontap_configuration.endpoints.intercluster.dns_name #=> String
|
3153
|
+
# resp.file_systems[0].ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
|
3154
|
+
# resp.file_systems[0].ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
|
3155
|
+
# resp.file_systems[0].ontap_configuration.endpoints.management.dns_name #=> String
|
3156
|
+
# resp.file_systems[0].ontap_configuration.endpoints.management.ip_addresses #=> Array
|
3157
|
+
# resp.file_systems[0].ontap_configuration.endpoints.management.ip_addresses[0] #=> String
|
3158
|
+
# resp.file_systems[0].ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
|
3159
|
+
# resp.file_systems[0].ontap_configuration.disk_iops_configuration.iops #=> Integer
|
3160
|
+
# resp.file_systems[0].ontap_configuration.preferred_subnet_id #=> String
|
3161
|
+
# resp.file_systems[0].ontap_configuration.route_table_ids #=> Array
|
3162
|
+
# resp.file_systems[0].ontap_configuration.route_table_ids[0] #=> String
|
3163
|
+
# resp.file_systems[0].ontap_configuration.throughput_capacity #=> Integer
|
3164
|
+
# resp.file_systems[0].ontap_configuration.weekly_maintenance_start_time #=> String
|
3165
|
+
# resp.file_systems[0].file_system_type_version #=> String
|
2380
3166
|
# resp.next_token #=> String
|
2381
3167
|
#
|
2382
3168
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeFileSystems AWS API Documentation
|
@@ -2388,6 +3174,167 @@ module Aws::FSx
|
|
2388
3174
|
req.send_request(options)
|
2389
3175
|
end
|
2390
3176
|
|
3177
|
+
# Describes one or more Amazon FSx for NetApp ONTAP storage virtual
|
3178
|
+
# machines (SVMs).
|
3179
|
+
#
|
3180
|
+
# @option params [Array<String>] :storage_virtual_machine_ids
|
3181
|
+
# Enter the ID of one or more SVMs that you want to view.
|
3182
|
+
#
|
3183
|
+
# @option params [Array<Types::StorageVirtualMachineFilter>] :filters
|
3184
|
+
# Enter a filter name:value pair to view a select set of SVMs.
|
3185
|
+
#
|
3186
|
+
# @option params [Integer] :max_results
|
3187
|
+
# The maximum number of resources to return in the response. This value
|
3188
|
+
# must be an integer greater than zero.
|
3189
|
+
#
|
3190
|
+
# @option params [String] :next_token
|
3191
|
+
# (Optional) Opaque pagination token returned from a previous operation
|
3192
|
+
# (String). If present, this token indicates from what point you can
|
3193
|
+
# continue processing the request, where the previous `NextToken` value
|
3194
|
+
# left off.
|
3195
|
+
#
|
3196
|
+
# @return [Types::DescribeStorageVirtualMachinesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3197
|
+
#
|
3198
|
+
# * {Types::DescribeStorageVirtualMachinesResponse#storage_virtual_machines #storage_virtual_machines} => Array<Types::StorageVirtualMachine>
|
3199
|
+
# * {Types::DescribeStorageVirtualMachinesResponse#next_token #next_token} => String
|
3200
|
+
#
|
3201
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3202
|
+
#
|
3203
|
+
# @example Request syntax with placeholder values
|
3204
|
+
#
|
3205
|
+
# resp = client.describe_storage_virtual_machines({
|
3206
|
+
# storage_virtual_machine_ids: ["StorageVirtualMachineId"],
|
3207
|
+
# filters: [
|
3208
|
+
# {
|
3209
|
+
# name: "file-system-id", # accepts file-system-id
|
3210
|
+
# values: ["StorageVirtualMachineFilterValue"],
|
3211
|
+
# },
|
3212
|
+
# ],
|
3213
|
+
# max_results: 1,
|
3214
|
+
# next_token: "NextToken",
|
3215
|
+
# })
|
3216
|
+
#
|
3217
|
+
# @example Response structure
|
3218
|
+
#
|
3219
|
+
# resp.storage_virtual_machines #=> Array
|
3220
|
+
# resp.storage_virtual_machines[0].active_directory_configuration.net_bios_name #=> String
|
3221
|
+
# resp.storage_virtual_machines[0].active_directory_configuration.self_managed_active_directory_configuration.domain_name #=> String
|
3222
|
+
# resp.storage_virtual_machines[0].active_directory_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
|
3223
|
+
# resp.storage_virtual_machines[0].active_directory_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
|
3224
|
+
# resp.storage_virtual_machines[0].active_directory_configuration.self_managed_active_directory_configuration.user_name #=> String
|
3225
|
+
# resp.storage_virtual_machines[0].active_directory_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
3226
|
+
# resp.storage_virtual_machines[0].active_directory_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
3227
|
+
# resp.storage_virtual_machines[0].creation_time #=> Time
|
3228
|
+
# resp.storage_virtual_machines[0].endpoints.iscsi.dns_name #=> String
|
3229
|
+
# resp.storage_virtual_machines[0].endpoints.iscsi.ip_addresses #=> Array
|
3230
|
+
# resp.storage_virtual_machines[0].endpoints.iscsi.ip_addresses[0] #=> String
|
3231
|
+
# resp.storage_virtual_machines[0].endpoints.management.dns_name #=> String
|
3232
|
+
# resp.storage_virtual_machines[0].endpoints.management.ip_addresses #=> Array
|
3233
|
+
# resp.storage_virtual_machines[0].endpoints.management.ip_addresses[0] #=> String
|
3234
|
+
# resp.storage_virtual_machines[0].endpoints.nfs.dns_name #=> String
|
3235
|
+
# resp.storage_virtual_machines[0].endpoints.nfs.ip_addresses #=> Array
|
3236
|
+
# resp.storage_virtual_machines[0].endpoints.nfs.ip_addresses[0] #=> String
|
3237
|
+
# resp.storage_virtual_machines[0].endpoints.smb.dns_name #=> String
|
3238
|
+
# resp.storage_virtual_machines[0].endpoints.smb.ip_addresses #=> Array
|
3239
|
+
# resp.storage_virtual_machines[0].endpoints.smb.ip_addresses[0] #=> String
|
3240
|
+
# resp.storage_virtual_machines[0].file_system_id #=> String
|
3241
|
+
# resp.storage_virtual_machines[0].lifecycle #=> String, one of "CREATED", "CREATING", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
3242
|
+
# resp.storage_virtual_machines[0].name #=> String
|
3243
|
+
# resp.storage_virtual_machines[0].resource_arn #=> String
|
3244
|
+
# resp.storage_virtual_machines[0].storage_virtual_machine_id #=> String
|
3245
|
+
# resp.storage_virtual_machines[0].subtype #=> String, one of "DEFAULT", "DP_DESTINATION", "SYNC_DESTINATION", "SYNC_SOURCE"
|
3246
|
+
# resp.storage_virtual_machines[0].uuid #=> String
|
3247
|
+
# resp.storage_virtual_machines[0].tags #=> Array
|
3248
|
+
# resp.storage_virtual_machines[0].tags[0].key #=> String
|
3249
|
+
# resp.storage_virtual_machines[0].tags[0].value #=> String
|
3250
|
+
# resp.storage_virtual_machines[0].lifecycle_transition_reason.message #=> String
|
3251
|
+
# resp.storage_virtual_machines[0].root_volume_security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
3252
|
+
# resp.next_token #=> String
|
3253
|
+
#
|
3254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeStorageVirtualMachines AWS API Documentation
|
3255
|
+
#
|
3256
|
+
# @overload describe_storage_virtual_machines(params = {})
|
3257
|
+
# @param [Hash] params ({})
|
3258
|
+
def describe_storage_virtual_machines(params = {}, options = {})
|
3259
|
+
req = build_request(:describe_storage_virtual_machines, params)
|
3260
|
+
req.send_request(options)
|
3261
|
+
end
|
3262
|
+
|
3263
|
+
# Describes one or more Amazon FSx for NetApp ONTAP volumes.
|
3264
|
+
#
|
3265
|
+
# @option params [Array<String>] :volume_ids
|
3266
|
+
# IDs of the volumes whose descriptions you want to retrieve.
|
3267
|
+
#
|
3268
|
+
# @option params [Array<Types::VolumeFilter>] :filters
|
3269
|
+
# Enter a filter name:value pair to view a select set of volumes.
|
3270
|
+
#
|
3271
|
+
# @option params [Integer] :max_results
|
3272
|
+
# The maximum number of resources to return in the response. This value
|
3273
|
+
# must be an integer greater than zero.
|
3274
|
+
#
|
3275
|
+
# @option params [String] :next_token
|
3276
|
+
# (Optional) Opaque pagination token returned from a previous operation
|
3277
|
+
# (String). If present, this token indicates from what point you can
|
3278
|
+
# continue processing the request, where the previous `NextToken` value
|
3279
|
+
# left off.
|
3280
|
+
#
|
3281
|
+
# @return [Types::DescribeVolumesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3282
|
+
#
|
3283
|
+
# * {Types::DescribeVolumesResponse#volumes #volumes} => Array<Types::Volume>
|
3284
|
+
# * {Types::DescribeVolumesResponse#next_token #next_token} => String
|
3285
|
+
#
|
3286
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3287
|
+
#
|
3288
|
+
# @example Request syntax with placeholder values
|
3289
|
+
#
|
3290
|
+
# resp = client.describe_volumes({
|
3291
|
+
# volume_ids: ["VolumeId"],
|
3292
|
+
# filters: [
|
3293
|
+
# {
|
3294
|
+
# name: "file-system-id", # accepts file-system-id, storage-virtual-machine-id
|
3295
|
+
# values: ["VolumeFilterValue"],
|
3296
|
+
# },
|
3297
|
+
# ],
|
3298
|
+
# max_results: 1,
|
3299
|
+
# next_token: "NextToken",
|
3300
|
+
# })
|
3301
|
+
#
|
3302
|
+
# @example Response structure
|
3303
|
+
#
|
3304
|
+
# resp.volumes #=> Array
|
3305
|
+
# resp.volumes[0].creation_time #=> Time
|
3306
|
+
# resp.volumes[0].file_system_id #=> String
|
3307
|
+
# resp.volumes[0].lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
3308
|
+
# resp.volumes[0].name #=> String
|
3309
|
+
# resp.volumes[0].ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
3310
|
+
# resp.volumes[0].ontap_configuration.junction_path #=> String
|
3311
|
+
# resp.volumes[0].ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
3312
|
+
# resp.volumes[0].ontap_configuration.size_in_megabytes #=> Integer
|
3313
|
+
# resp.volumes[0].ontap_configuration.storage_efficiency_enabled #=> Boolean
|
3314
|
+
# resp.volumes[0].ontap_configuration.storage_virtual_machine_id #=> String
|
3315
|
+
# resp.volumes[0].ontap_configuration.storage_virtual_machine_root #=> Boolean
|
3316
|
+
# resp.volumes[0].ontap_configuration.tiering_policy.cooling_period #=> Integer
|
3317
|
+
# resp.volumes[0].ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
3318
|
+
# resp.volumes[0].ontap_configuration.uuid #=> String
|
3319
|
+
# resp.volumes[0].ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
3320
|
+
# resp.volumes[0].resource_arn #=> String
|
3321
|
+
# resp.volumes[0].tags #=> Array
|
3322
|
+
# resp.volumes[0].tags[0].key #=> String
|
3323
|
+
# resp.volumes[0].tags[0].value #=> String
|
3324
|
+
# resp.volumes[0].volume_id #=> String
|
3325
|
+
# resp.volumes[0].volume_type #=> String, one of "ONTAP"
|
3326
|
+
# resp.volumes[0].lifecycle_transition_reason.message #=> String
|
3327
|
+
# resp.next_token #=> String
|
3328
|
+
#
|
3329
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumes AWS API Documentation
|
3330
|
+
#
|
3331
|
+
# @overload describe_volumes(params = {})
|
3332
|
+
# @param [Hash] params ({})
|
3333
|
+
def describe_volumes(params = {}, options = {})
|
3334
|
+
req = build_request(:describe_volumes, params)
|
3335
|
+
req.send_request(options)
|
3336
|
+
end
|
3337
|
+
|
2391
3338
|
# Use this action to disassociate, or remove, one or more Domain Name
|
2392
3339
|
# Service (DNS) aliases from an Amazon FSx for Windows File Server file
|
2393
3340
|
# system. If you attempt to disassociate a DNS alias that is not
|
@@ -2406,8 +3353,8 @@ module Aws::FSx
|
|
2406
3353
|
# @option params [String] :client_request_token
|
2407
3354
|
# (Optional) An idempotency token for resource creation, in a string of
|
2408
3355
|
# up to 64 ASCII characters. This token is automatically filled on your
|
2409
|
-
# behalf when you use the
|
2410
|
-
# SDK.
|
3356
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
3357
|
+
# Services SDK.
|
2411
3358
|
#
|
2412
3359
|
# **A suitable default value is auto-generated.** You should normally
|
2413
3360
|
# not need to pass this option.**
|
@@ -2490,6 +3437,8 @@ module Aws::FSx
|
|
2490
3437
|
# * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag>
|
2491
3438
|
# * {Types::ListTagsForResourceResponse#next_token #next_token} => String
|
2492
3439
|
#
|
3440
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3441
|
+
#
|
2493
3442
|
#
|
2494
3443
|
# @example Example: To list tags for a resource
|
2495
3444
|
#
|
@@ -2656,23 +3605,36 @@ module Aws::FSx
|
|
2656
3605
|
#
|
2657
3606
|
# * WeeklyMaintenanceStartTime
|
2658
3607
|
#
|
3608
|
+
# For Amazon FSx for NetApp ONTAP file systems, you can update the
|
3609
|
+
# following properties:
|
3610
|
+
#
|
3611
|
+
# * AutomaticBackupRetentionDays
|
3612
|
+
#
|
3613
|
+
# * DailyAutomaticBackupStartTime
|
3614
|
+
#
|
3615
|
+
# * FsxAdminPassword
|
3616
|
+
#
|
3617
|
+
# * WeeklyMaintenanceStartTime
|
3618
|
+
#
|
2659
3619
|
# @option params [required, String] :file_system_id
|
2660
3620
|
# Identifies the file system that you are updating.
|
2661
3621
|
#
|
2662
3622
|
# @option params [String] :client_request_token
|
2663
3623
|
# A string of up to 64 ASCII characters that Amazon FSx uses to ensure
|
2664
3624
|
# idempotent updates. This string is automatically filled on your behalf
|
2665
|
-
# when you use the
|
3625
|
+
# when you use the Command Line Interface (CLI) or an Amazon Web
|
3626
|
+
# Services SDK.
|
2666
3627
|
#
|
2667
3628
|
# **A suitable default value is auto-generated.** You should normally
|
2668
3629
|
# not need to pass this option.**
|
2669
3630
|
#
|
2670
3631
|
# @option params [Integer] :storage_capacity
|
2671
3632
|
# Use this parameter to increase the storage capacity of an Amazon FSx
|
2672
|
-
#
|
2673
|
-
#
|
2674
|
-
#
|
2675
|
-
#
|
3633
|
+
# for Windows File Server or Amazon FSx for Lustre file system.
|
3634
|
+
# Specifies the storage capacity target value, GiB, to increase the
|
3635
|
+
# storage capacity for the file system that you're updating. You cannot
|
3636
|
+
# make a storage capacity increase request if there is an existing
|
3637
|
+
# storage capacity increase request in progress.
|
2676
3638
|
#
|
2677
3639
|
# For Windows file systems, the storage capacity target value must be at
|
2678
3640
|
# least 10 percent (%) greater than the current storage capacity value.
|
@@ -2711,6 +3673,10 @@ module Aws::FSx
|
|
2711
3673
|
# The configuration object for Amazon FSx for Lustre file systems used
|
2712
3674
|
# in the `UpdateFileSystem` operation.
|
2713
3675
|
#
|
3676
|
+
# @option params [Types::UpdateFileSystemOntapConfiguration] :ontap_configuration
|
3677
|
+
# The configuration updates for an Amazon FSx for NetApp ONTAP file
|
3678
|
+
# system.
|
3679
|
+
#
|
2714
3680
|
# @return [Types::UpdateFileSystemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2715
3681
|
#
|
2716
3682
|
# * {Types::UpdateFileSystemResponse#file_system #file_system} => Types::FileSystem
|
@@ -2788,6 +3754,12 @@ module Aws::FSx
|
|
2788
3754
|
# auto_import_policy: "NONE", # accepts NONE, NEW, NEW_CHANGED
|
2789
3755
|
# data_compression_type: "NONE", # accepts NONE, LZ4
|
2790
3756
|
# },
|
3757
|
+
# ontap_configuration: {
|
3758
|
+
# automatic_backup_retention_days: 1,
|
3759
|
+
# daily_automatic_backup_start_time: "DailyTime",
|
3760
|
+
# fsx_admin_password: "AdminPassword",
|
3761
|
+
# weekly_maintenance_start_time: "WeeklyTime",
|
3762
|
+
# },
|
2791
3763
|
# })
|
2792
3764
|
#
|
2793
3765
|
# @example Response structure
|
@@ -2795,7 +3767,7 @@ module Aws::FSx
|
|
2795
3767
|
# resp.file_system.owner_id #=> String
|
2796
3768
|
# resp.file_system.creation_time #=> Time
|
2797
3769
|
# resp.file_system.file_system_id #=> String
|
2798
|
-
# resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE"
|
3770
|
+
# resp.file_system.file_system_type #=> String, one of "WINDOWS", "LUSTRE", "ONTAP"
|
2799
3771
|
# resp.file_system.lifecycle #=> String, one of "AVAILABLE", "CREATING", "FAILED", "DELETING", "MISCONFIGURED", "UPDATING"
|
2800
3772
|
# resp.file_system.failure_details.message #=> String
|
2801
3773
|
# resp.file_system.storage_capacity #=> Integer
|
@@ -2857,6 +3829,46 @@ module Aws::FSx
|
|
2857
3829
|
# resp.file_system.administrative_actions[0].status #=> String, one of "FAILED", "IN_PROGRESS", "PENDING", "COMPLETED", "UPDATED_OPTIMIZING"
|
2858
3830
|
# resp.file_system.administrative_actions[0].target_file_system_values #=> Types::FileSystem
|
2859
3831
|
# resp.file_system.administrative_actions[0].failure_details.message #=> String
|
3832
|
+
# resp.file_system.administrative_actions[0].target_volume_values.creation_time #=> Time
|
3833
|
+
# resp.file_system.administrative_actions[0].target_volume_values.file_system_id #=> String
|
3834
|
+
# resp.file_system.administrative_actions[0].target_volume_values.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
3835
|
+
# resp.file_system.administrative_actions[0].target_volume_values.name #=> String
|
3836
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
3837
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.junction_path #=> String
|
3838
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
3839
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.size_in_megabytes #=> Integer
|
3840
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
3841
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_id #=> String
|
3842
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
3843
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
3844
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
3845
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.uuid #=> String
|
3846
|
+
# resp.file_system.administrative_actions[0].target_volume_values.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
3847
|
+
# resp.file_system.administrative_actions[0].target_volume_values.resource_arn #=> String
|
3848
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags #=> Array
|
3849
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags[0].key #=> String
|
3850
|
+
# resp.file_system.administrative_actions[0].target_volume_values.tags[0].value #=> String
|
3851
|
+
# resp.file_system.administrative_actions[0].target_volume_values.volume_id #=> String
|
3852
|
+
# resp.file_system.administrative_actions[0].target_volume_values.volume_type #=> String, one of "ONTAP"
|
3853
|
+
# resp.file_system.administrative_actions[0].target_volume_values.lifecycle_transition_reason.message #=> String
|
3854
|
+
# resp.file_system.ontap_configuration.automatic_backup_retention_days #=> Integer
|
3855
|
+
# resp.file_system.ontap_configuration.daily_automatic_backup_start_time #=> String
|
3856
|
+
# resp.file_system.ontap_configuration.deployment_type #=> String, one of "MULTI_AZ_1"
|
3857
|
+
# resp.file_system.ontap_configuration.endpoint_ip_address_range #=> String
|
3858
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.dns_name #=> String
|
3859
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses #=> Array
|
3860
|
+
# resp.file_system.ontap_configuration.endpoints.intercluster.ip_addresses[0] #=> String
|
3861
|
+
# resp.file_system.ontap_configuration.endpoints.management.dns_name #=> String
|
3862
|
+
# resp.file_system.ontap_configuration.endpoints.management.ip_addresses #=> Array
|
3863
|
+
# resp.file_system.ontap_configuration.endpoints.management.ip_addresses[0] #=> String
|
3864
|
+
# resp.file_system.ontap_configuration.disk_iops_configuration.mode #=> String, one of "AUTOMATIC", "USER_PROVISIONED"
|
3865
|
+
# resp.file_system.ontap_configuration.disk_iops_configuration.iops #=> Integer
|
3866
|
+
# resp.file_system.ontap_configuration.preferred_subnet_id #=> String
|
3867
|
+
# resp.file_system.ontap_configuration.route_table_ids #=> Array
|
3868
|
+
# resp.file_system.ontap_configuration.route_table_ids[0] #=> String
|
3869
|
+
# resp.file_system.ontap_configuration.throughput_capacity #=> Integer
|
3870
|
+
# resp.file_system.ontap_configuration.weekly_maintenance_start_time #=> String
|
3871
|
+
# resp.file_system.file_system_type_version #=> String
|
2860
3872
|
#
|
2861
3873
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystem AWS API Documentation
|
2862
3874
|
#
|
@@ -2867,6 +3879,164 @@ module Aws::FSx
|
|
2867
3879
|
req.send_request(options)
|
2868
3880
|
end
|
2869
3881
|
|
3882
|
+
# Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
|
3883
|
+
#
|
3884
|
+
# @option params [Types::UpdateSvmActiveDirectoryConfiguration] :active_directory_configuration
|
3885
|
+
# Updates the Microsoft Active Directory (AD) configuration for an SVM
|
3886
|
+
# that is joined to an AD.
|
3887
|
+
#
|
3888
|
+
# @option params [String] :client_request_token
|
3889
|
+
# (Optional) An idempotency token for resource creation, in a string of
|
3890
|
+
# up to 64 ASCII characters. This token is automatically filled on your
|
3891
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
3892
|
+
# Services SDK.
|
3893
|
+
#
|
3894
|
+
# **A suitable default value is auto-generated.** You should normally
|
3895
|
+
# not need to pass this option.**
|
3896
|
+
#
|
3897
|
+
# @option params [required, String] :storage_virtual_machine_id
|
3898
|
+
# The ID of the SVM that you want to update, in the format
|
3899
|
+
# `svm-0123456789abcdef0`.
|
3900
|
+
#
|
3901
|
+
# @option params [String] :svm_admin_password
|
3902
|
+
# Enter a new SvmAdminPassword if you are updating it.
|
3903
|
+
#
|
3904
|
+
# @return [Types::UpdateStorageVirtualMachineResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3905
|
+
#
|
3906
|
+
# * {Types::UpdateStorageVirtualMachineResponse#storage_virtual_machine #storage_virtual_machine} => Types::StorageVirtualMachine
|
3907
|
+
#
|
3908
|
+
# @example Request syntax with placeholder values
|
3909
|
+
#
|
3910
|
+
# resp = client.update_storage_virtual_machine({
|
3911
|
+
# active_directory_configuration: {
|
3912
|
+
# self_managed_active_directory_configuration: {
|
3913
|
+
# user_name: "DirectoryUserName",
|
3914
|
+
# password: "DirectoryPassword",
|
3915
|
+
# dns_ips: ["IpAddress"],
|
3916
|
+
# },
|
3917
|
+
# },
|
3918
|
+
# client_request_token: "ClientRequestToken",
|
3919
|
+
# storage_virtual_machine_id: "StorageVirtualMachineId", # required
|
3920
|
+
# svm_admin_password: "AdminPassword",
|
3921
|
+
# })
|
3922
|
+
#
|
3923
|
+
# @example Response structure
|
3924
|
+
#
|
3925
|
+
# resp.storage_virtual_machine.active_directory_configuration.net_bios_name #=> String
|
3926
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.domain_name #=> String
|
3927
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.organizational_unit_distinguished_name #=> String
|
3928
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.file_system_administrators_group #=> String
|
3929
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.user_name #=> String
|
3930
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.dns_ips #=> Array
|
3931
|
+
# resp.storage_virtual_machine.active_directory_configuration.self_managed_active_directory_configuration.dns_ips[0] #=> String
|
3932
|
+
# resp.storage_virtual_machine.creation_time #=> Time
|
3933
|
+
# resp.storage_virtual_machine.endpoints.iscsi.dns_name #=> String
|
3934
|
+
# resp.storage_virtual_machine.endpoints.iscsi.ip_addresses #=> Array
|
3935
|
+
# resp.storage_virtual_machine.endpoints.iscsi.ip_addresses[0] #=> String
|
3936
|
+
# resp.storage_virtual_machine.endpoints.management.dns_name #=> String
|
3937
|
+
# resp.storage_virtual_machine.endpoints.management.ip_addresses #=> Array
|
3938
|
+
# resp.storage_virtual_machine.endpoints.management.ip_addresses[0] #=> String
|
3939
|
+
# resp.storage_virtual_machine.endpoints.nfs.dns_name #=> String
|
3940
|
+
# resp.storage_virtual_machine.endpoints.nfs.ip_addresses #=> Array
|
3941
|
+
# resp.storage_virtual_machine.endpoints.nfs.ip_addresses[0] #=> String
|
3942
|
+
# resp.storage_virtual_machine.endpoints.smb.dns_name #=> String
|
3943
|
+
# resp.storage_virtual_machine.endpoints.smb.ip_addresses #=> Array
|
3944
|
+
# resp.storage_virtual_machine.endpoints.smb.ip_addresses[0] #=> String
|
3945
|
+
# resp.storage_virtual_machine.file_system_id #=> String
|
3946
|
+
# resp.storage_virtual_machine.lifecycle #=> String, one of "CREATED", "CREATING", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
3947
|
+
# resp.storage_virtual_machine.name #=> String
|
3948
|
+
# resp.storage_virtual_machine.resource_arn #=> String
|
3949
|
+
# resp.storage_virtual_machine.storage_virtual_machine_id #=> String
|
3950
|
+
# resp.storage_virtual_machine.subtype #=> String, one of "DEFAULT", "DP_DESTINATION", "SYNC_DESTINATION", "SYNC_SOURCE"
|
3951
|
+
# resp.storage_virtual_machine.uuid #=> String
|
3952
|
+
# resp.storage_virtual_machine.tags #=> Array
|
3953
|
+
# resp.storage_virtual_machine.tags[0].key #=> String
|
3954
|
+
# resp.storage_virtual_machine.tags[0].value #=> String
|
3955
|
+
# resp.storage_virtual_machine.lifecycle_transition_reason.message #=> String
|
3956
|
+
# resp.storage_virtual_machine.root_volume_security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
3957
|
+
#
|
3958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateStorageVirtualMachine AWS API Documentation
|
3959
|
+
#
|
3960
|
+
# @overload update_storage_virtual_machine(params = {})
|
3961
|
+
# @param [Hash] params ({})
|
3962
|
+
def update_storage_virtual_machine(params = {}, options = {})
|
3963
|
+
req = build_request(:update_storage_virtual_machine, params)
|
3964
|
+
req.send_request(options)
|
3965
|
+
end
|
3966
|
+
|
3967
|
+
# Updates an Amazon FSx for NetApp ONTAP volume's configuration.
|
3968
|
+
#
|
3969
|
+
# @option params [String] :client_request_token
|
3970
|
+
# (Optional) An idempotency token for resource creation, in a string of
|
3971
|
+
# up to 64 ASCII characters. This token is automatically filled on your
|
3972
|
+
# behalf when you use the Command Line Interface (CLI) or an Amazon Web
|
3973
|
+
# Services SDK.
|
3974
|
+
#
|
3975
|
+
# **A suitable default value is auto-generated.** You should normally
|
3976
|
+
# not need to pass this option.**
|
3977
|
+
#
|
3978
|
+
# @option params [required, String] :volume_id
|
3979
|
+
# Specifies the volume that you want to update, formatted
|
3980
|
+
# `fsvol-0123456789abcdef0`.
|
3981
|
+
#
|
3982
|
+
# @option params [Types::UpdateOntapVolumeConfiguration] :ontap_configuration
|
3983
|
+
# The `ONTAP` configuration of the volume you are updating.
|
3984
|
+
#
|
3985
|
+
# @return [Types::UpdateVolumeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3986
|
+
#
|
3987
|
+
# * {Types::UpdateVolumeResponse#volume #volume} => Types::Volume
|
3988
|
+
#
|
3989
|
+
# @example Request syntax with placeholder values
|
3990
|
+
#
|
3991
|
+
# resp = client.update_volume({
|
3992
|
+
# client_request_token: "ClientRequestToken",
|
3993
|
+
# volume_id: "VolumeId", # required
|
3994
|
+
# ontap_configuration: {
|
3995
|
+
# junction_path: "JunctionPath",
|
3996
|
+
# security_style: "UNIX", # accepts UNIX, NTFS, MIXED
|
3997
|
+
# size_in_megabytes: 1,
|
3998
|
+
# storage_efficiency_enabled: false,
|
3999
|
+
# tiering_policy: {
|
4000
|
+
# cooling_period: 1,
|
4001
|
+
# name: "SNAPSHOT_ONLY", # accepts SNAPSHOT_ONLY, AUTO, ALL, NONE
|
4002
|
+
# },
|
4003
|
+
# },
|
4004
|
+
# })
|
4005
|
+
#
|
4006
|
+
# @example Response structure
|
4007
|
+
#
|
4008
|
+
# resp.volume.creation_time #=> Time
|
4009
|
+
# resp.volume.file_system_id #=> String
|
4010
|
+
# resp.volume.lifecycle #=> String, one of "CREATING", "CREATED", "DELETING", "FAILED", "MISCONFIGURED", "PENDING"
|
4011
|
+
# resp.volume.name #=> String
|
4012
|
+
# resp.volume.ontap_configuration.flex_cache_endpoint_type #=> String, one of "NONE", "ORIGIN", "CACHE"
|
4013
|
+
# resp.volume.ontap_configuration.junction_path #=> String
|
4014
|
+
# resp.volume.ontap_configuration.security_style #=> String, one of "UNIX", "NTFS", "MIXED"
|
4015
|
+
# resp.volume.ontap_configuration.size_in_megabytes #=> Integer
|
4016
|
+
# resp.volume.ontap_configuration.storage_efficiency_enabled #=> Boolean
|
4017
|
+
# resp.volume.ontap_configuration.storage_virtual_machine_id #=> String
|
4018
|
+
# resp.volume.ontap_configuration.storage_virtual_machine_root #=> Boolean
|
4019
|
+
# resp.volume.ontap_configuration.tiering_policy.cooling_period #=> Integer
|
4020
|
+
# resp.volume.ontap_configuration.tiering_policy.name #=> String, one of "SNAPSHOT_ONLY", "AUTO", "ALL", "NONE"
|
4021
|
+
# resp.volume.ontap_configuration.uuid #=> String
|
4022
|
+
# resp.volume.ontap_configuration.ontap_volume_type #=> String, one of "RW", "DP", "LS"
|
4023
|
+
# resp.volume.resource_arn #=> String
|
4024
|
+
# resp.volume.tags #=> Array
|
4025
|
+
# resp.volume.tags[0].key #=> String
|
4026
|
+
# resp.volume.tags[0].value #=> String
|
4027
|
+
# resp.volume.volume_id #=> String
|
4028
|
+
# resp.volume.volume_type #=> String, one of "ONTAP"
|
4029
|
+
# resp.volume.lifecycle_transition_reason.message #=> String
|
4030
|
+
#
|
4031
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolume AWS API Documentation
|
4032
|
+
#
|
4033
|
+
# @overload update_volume(params = {})
|
4034
|
+
# @param [Hash] params ({})
|
4035
|
+
def update_volume(params = {}, options = {})
|
4036
|
+
req = build_request(:update_volume, params)
|
4037
|
+
req.send_request(options)
|
4038
|
+
end
|
4039
|
+
|
2870
4040
|
# @!endgroup
|
2871
4041
|
|
2872
4042
|
# @param params ({})
|
@@ -2880,7 +4050,7 @@ module Aws::FSx
|
|
2880
4050
|
params: params,
|
2881
4051
|
config: config)
|
2882
4052
|
context[:gem_name] = 'aws-sdk-fsx'
|
2883
|
-
context[:gem_version] = '1.
|
4053
|
+
context[:gem_version] = '1.45.0'
|
2884
4054
|
Seahorse::Client::Request.new(handlers, context)
|
2885
4055
|
end
|
2886
4056
|
|