aws-sdk-fsx 1.72.0 → 1.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-fsx/client.rb +576 -57
- data/lib/aws-sdk-fsx/client_api.rb +78 -0
- data/lib/aws-sdk-fsx/types.rb +751 -73
- data/lib/aws-sdk-fsx.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-fsx/types.rb
CHANGED
@@ -79,6 +79,17 @@ module Aws::FSx
|
|
79
79
|
# initiated from the Amazon FSx console, API (`UpdateFileSystem`),
|
80
80
|
# or CLI (`update-file-system`).
|
81
81
|
#
|
82
|
+
# * `THROUGHPUT_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task to
|
83
|
+
# increase a file system's throughput capacity has been completed
|
84
|
+
# successfully, a `THROUGHPUT_OPTIMIZATION` task starts.
|
85
|
+
#
|
86
|
+
# You can track the storage-optimization progress using the
|
87
|
+
# `ProgressPercent` property. When `THROUGHPUT_OPTIMIZATION` has
|
88
|
+
# been completed successfully, the parent `FILE_SYSTEM_UPDATE`
|
89
|
+
# action status changes to `COMPLETED`. For more information, see
|
90
|
+
# [Managing throughput capacity][1] in the *Amazon FSx for Windows
|
91
|
+
# File Server User Guide*.
|
92
|
+
#
|
82
93
|
# * `STORAGE_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task to
|
83
94
|
# increase a file system's storage capacity has been completed
|
84
95
|
# successfully, a `STORAGE_OPTIMIZATION` task starts.
|
@@ -93,20 +104,40 @@ module Aws::FSx
|
|
93
104
|
# `ProgressPercent` property. When `STORAGE_OPTIMIZATION` has been
|
94
105
|
# completed successfully, the parent `FILE_SYSTEM_UPDATE` action
|
95
106
|
# status changes to `COMPLETED`. For more information, see [Managing
|
96
|
-
# storage capacity][
|
97
|
-
# User Guide*, [Managing storage and throughput capacity][
|
107
|
+
# storage capacity][2] in the *Amazon FSx for Windows File Server
|
108
|
+
# User Guide*, [Managing storage and throughput capacity][3] in the
|
98
109
|
# *Amazon FSx for Lustre User Guide*, and [Managing storage capacity
|
99
|
-
# and provisioned IOPS][
|
110
|
+
# and provisioned IOPS][4] in the *Amazon FSx for NetApp ONTAP User
|
100
111
|
# Guide*.
|
101
112
|
#
|
102
113
|
# * `FILE_SYSTEM_ALIAS_ASSOCIATION` - A file system update to
|
103
114
|
# associate a new Domain Name System (DNS) alias with the file
|
104
115
|
# system. For more information, see [
|
105
|
-
# AssociateFileSystemAliases][
|
116
|
+
# AssociateFileSystemAliases][5].
|
106
117
|
#
|
107
118
|
# * `FILE_SYSTEM_ALIAS_DISASSOCIATION` - A file system update to
|
108
119
|
# disassociate a DNS alias from the file system. For more
|
109
|
-
# information, see [DisassociateFileSystemAliases][
|
120
|
+
# information, see [DisassociateFileSystemAliases][6].
|
121
|
+
#
|
122
|
+
# * `IOPS_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task to
|
123
|
+
# increase a file system's throughput capacity has been completed
|
124
|
+
# successfully, a `IOPS_OPTIMIZATION` task starts.
|
125
|
+
#
|
126
|
+
# You can track the storage-optimization progress using the
|
127
|
+
# `ProgressPercent` property. When `IOPS_OPTIMIZATION` has been
|
128
|
+
# completed successfully, the parent `FILE_SYSTEM_UPDATE` action
|
129
|
+
# status changes to `COMPLETED`. For more information, see [Managing
|
130
|
+
# provisioned SSD IOPS][7] in the *Amazon FSx for Windows File
|
131
|
+
# Server User Guide*.
|
132
|
+
#
|
133
|
+
# * `STORAGE_TYPE_OPTIMIZATION` - After the `FILE_SYSTEM_UPDATE` task
|
134
|
+
# to increase a file system's throughput capacity has been
|
135
|
+
# completed successfully, a `STORAGE_TYPE_OPTIMIZATION` task starts.
|
136
|
+
#
|
137
|
+
# You can track the storage-optimization progress using the
|
138
|
+
# `ProgressPercent` property. When `STORAGE_TYPE_OPTIMIZATION` has
|
139
|
+
# been completed successfully, the parent `FILE_SYSTEM_UPDATE`
|
140
|
+
# action status changes to `COMPLETED`.
|
110
141
|
#
|
111
142
|
# * `VOLUME_UPDATE` - A volume update to an Amazon FSx for NetApp
|
112
143
|
# ONTAP or Amazon FSx for OpenZFS volume initiated from the Amazon
|
@@ -126,11 +157,13 @@ module Aws::FSx
|
|
126
157
|
#
|
127
158
|
#
|
128
159
|
#
|
129
|
-
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-
|
130
|
-
# [2]: https://docs.aws.amazon.com/fsx/latest/
|
131
|
-
# [3]: https://docs.aws.amazon.com/fsx/latest/
|
132
|
-
# [4]: https://docs.aws.amazon.com/fsx/latest/
|
133
|
-
# [5]: https://docs.aws.amazon.com/fsx/latest/APIReference/
|
160
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-throughput-capacity.html
|
161
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-storage-capacity.html
|
162
|
+
# [3]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/managing-storage-capacity.html
|
163
|
+
# [4]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-storage-capacity.html
|
164
|
+
# [5]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_AssociateFileSystemAliases.html
|
165
|
+
# [6]: https://docs.aws.amazon.com/fsx/latest/APIReference/API_DisassociateFileSystemAliases.html
|
166
|
+
# [7]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-provisioned-ssd-iops.html
|
134
167
|
# @return [String]
|
135
168
|
#
|
136
169
|
# @!attribute [rw] progress_percent
|
@@ -407,6 +440,47 @@ module Aws::FSx
|
|
407
440
|
include Aws::Structure
|
408
441
|
end
|
409
442
|
|
443
|
+
# Sets the autocommit period of files in an FSx for ONTAP SnapLock
|
444
|
+
# volume, which determines how long the files must remain unmodified
|
445
|
+
# before they're automatically transitioned to the write once, read
|
446
|
+
# many (WORM) state.
|
447
|
+
#
|
448
|
+
# For more information, see [Autocommit][1].
|
449
|
+
#
|
450
|
+
#
|
451
|
+
#
|
452
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-autocommit
|
453
|
+
#
|
454
|
+
# @!attribute [rw] type
|
455
|
+
# Defines the type of time for the autocommit period of a file in an
|
456
|
+
# FSx for ONTAP SnapLock volume. Setting this value to `NONE` disables
|
457
|
+
# autocommit. The default value is `NONE`.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @!attribute [rw] value
|
461
|
+
# Defines the amount of time for the autocommit period of a file in an
|
462
|
+
# FSx for ONTAP SnapLock volume. The following ranges are valid:
|
463
|
+
#
|
464
|
+
# * `Minutes`: 5 - 65,535
|
465
|
+
#
|
466
|
+
# * `Hours`: 1 - 65,535
|
467
|
+
#
|
468
|
+
# * `Days`: 1 - 3,650
|
469
|
+
#
|
470
|
+
# * `Months`: 1 - 120
|
471
|
+
#
|
472
|
+
# * `Years`: 1 - 10
|
473
|
+
# @return [Integer]
|
474
|
+
#
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/AutocommitPeriod AWS API Documentation
|
476
|
+
#
|
477
|
+
class AutocommitPeriod < Struct.new(
|
478
|
+
:type,
|
479
|
+
:value)
|
480
|
+
SENSITIVE = []
|
481
|
+
include Aws::Structure
|
482
|
+
end
|
483
|
+
|
410
484
|
# A backup of an Amazon FSx for Windows File Server, Amazon FSx for
|
411
485
|
# Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx
|
412
486
|
# for OpenZFS file system.
|
@@ -969,24 +1043,53 @@ module Aws::FSx
|
|
969
1043
|
|
970
1044
|
# @!attribute [rw] type
|
971
1045
|
# Specifies the type of data repository task to create.
|
1046
|
+
#
|
1047
|
+
# * `EXPORT_TO_REPOSITORY` tasks export from your Amazon FSx for
|
1048
|
+
# Lustre file system to a linked data repository.
|
1049
|
+
#
|
1050
|
+
# * `IMPORT_METADATA_FROM_REPOSITORY` tasks import metadata changes
|
1051
|
+
# from a linked S3 bucket to your Amazon FSx for Lustre file system.
|
1052
|
+
#
|
1053
|
+
# * `RELEASE_DATA_FROM_FILESYSTEM` tasks release files in your Amazon
|
1054
|
+
# FSx for Lustre file system that are archived and that meet your
|
1055
|
+
# specified release criteria.
|
1056
|
+
#
|
1057
|
+
# * `AUTO_RELEASE_DATA` tasks automatically release files from an
|
1058
|
+
# Amazon File Cache resource.
|
972
1059
|
# @return [String]
|
973
1060
|
#
|
974
1061
|
# @!attribute [rw] paths
|
975
1062
|
# A list of paths for the data repository task to use when the task is
|
976
1063
|
# processed. If a path that you provide isn't valid, the task fails.
|
977
|
-
#
|
978
|
-
#
|
979
|
-
#
|
980
|
-
#
|
981
|
-
#
|
982
|
-
#
|
983
|
-
#
|
984
|
-
#
|
1064
|
+
# If you don't provide paths, the default behavior is to export all
|
1065
|
+
# files to S3 (for export tasks), import all files from S3 (for import
|
1066
|
+
# tasks), or release all archived files that meet the last accessed
|
1067
|
+
# time criteria (for release tasks).
|
1068
|
+
#
|
1069
|
+
# * For export tasks, the list contains paths on the FSx for Lustre
|
1070
|
+
# file system from which the files are exported to the Amazon S3
|
1071
|
+
# bucket. The default path is the file system root directory. The
|
1072
|
+
# paths you provide need to be relative to the mount point of the
|
1073
|
+
# file system. If the mount point is `/mnt/fsx` and `/mnt/fsx/path1`
|
1074
|
+
# is a directory or file on the file system you want to export, then
|
1075
|
+
# the path to provide is `path1`.
|
985
1076
|
#
|
986
1077
|
# * For import tasks, the list contains paths in the Amazon S3 bucket
|
987
|
-
# from which POSIX metadata changes are imported to the
|
988
|
-
# file system. The path can be an S3 bucket or prefix in the
|
989
|
-
# `s3://myBucket/myPrefix` (where `myPrefix` is optional).
|
1078
|
+
# from which POSIX metadata changes are imported to the FSx for
|
1079
|
+
# Lustre file system. The path can be an S3 bucket or prefix in the
|
1080
|
+
# format `s3://myBucket/myPrefix` (where `myPrefix` is optional).
|
1081
|
+
#
|
1082
|
+
# * For release tasks, the list contains directory or file paths on
|
1083
|
+
# the FSx for Lustre file system from which to release archived
|
1084
|
+
# files. If a directory is specified, files within the directory are
|
1085
|
+
# released. If a file path is specified, only that file is released.
|
1086
|
+
# To release all archived files in the file system, specify a
|
1087
|
+
# forward slash (/) as the path.
|
1088
|
+
#
|
1089
|
+
# <note markdown="1"> A file must also meet the last accessed time criteria specified in
|
1090
|
+
# for the file to be released.
|
1091
|
+
#
|
1092
|
+
# </note>
|
990
1093
|
# @return [Array<String>]
|
991
1094
|
#
|
992
1095
|
# @!attribute [rw] file_system_id
|
@@ -1025,6 +1128,12 @@ module Aws::FSx
|
|
1025
1128
|
# from the cache.
|
1026
1129
|
# @return [Integer]
|
1027
1130
|
#
|
1131
|
+
# @!attribute [rw] release_configuration
|
1132
|
+
# The configuration that specifies the last accessed time criteria for
|
1133
|
+
# files that will be released from an Amazon FSx for Lustre file
|
1134
|
+
# system.
|
1135
|
+
# @return [Types::ReleaseConfiguration]
|
1136
|
+
#
|
1028
1137
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateDataRepositoryTaskRequest AWS API Documentation
|
1029
1138
|
#
|
1030
1139
|
class CreateDataRepositoryTaskRequest < Struct.new(
|
@@ -1034,7 +1143,8 @@ module Aws::FSx
|
|
1034
1143
|
:report,
|
1035
1144
|
:client_request_token,
|
1036
1145
|
:tags,
|
1037
|
-
:capacity_to_release
|
1146
|
+
:capacity_to_release,
|
1147
|
+
:release_configuration)
|
1038
1148
|
SENSITIVE = []
|
1039
1149
|
include Aws::Structure
|
1040
1150
|
end
|
@@ -1816,8 +1926,13 @@ module Aws::FSx
|
|
1816
1926
|
# Zone in an Amazon Web Services Region . Valid values are the
|
1817
1927
|
# following:
|
1818
1928
|
#
|
1929
|
+
# * `MULTI_AZ_1`- Creates file systems with high availability that are
|
1930
|
+
# configured for Multi-AZ redundancy to tolerate temporary
|
1931
|
+
# unavailability in Availability Zones (AZs). `Multi_AZ_1` is
|
1932
|
+
# available in the following Amazon Web Services Regions:
|
1933
|
+
#
|
1819
1934
|
# * `SINGLE_AZ_1`- (Default) Creates file systems with throughput
|
1820
|
-
# capacities of 64 - 4,096
|
1935
|
+
# capacities of 64 - 4,096 MB/s. `Single_AZ_1` is available in all
|
1821
1936
|
# Amazon Web Services Regions where Amazon FSx for OpenZFS is
|
1822
1937
|
# available.
|
1823
1938
|
#
|
@@ -1869,12 +1984,12 @@ module Aws::FSx
|
|
1869
1984
|
#
|
1870
1985
|
# @!attribute [rw] disk_iops_configuration
|
1871
1986
|
# The SSD IOPS (input/output operations per second) configuration for
|
1872
|
-
# an Amazon FSx for NetApp ONTAP
|
1873
|
-
#
|
1874
|
-
# storage capacity. You can provision
|
1875
|
-
# storage. The configuration consists of the
|
1876
|
-
# provisioned SSD IOPS and how it is was provisioned,
|
1877
|
-
# the customer or by Amazon FSx).
|
1987
|
+
# an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server,
|
1988
|
+
# or FSx for OpenZFS file system. By default, Amazon FSx automatically
|
1989
|
+
# provisions 3 IOPS per GB of storage capacity. You can provision
|
1990
|
+
# additional IOPS per GB of storage. The configuration consists of the
|
1991
|
+
# total number of provisioned SSD IOPS and how it is was provisioned,
|
1992
|
+
# or the mode (by the customer or by Amazon FSx).
|
1878
1993
|
# @return [Types::DiskIopsConfiguration]
|
1879
1994
|
#
|
1880
1995
|
# @!attribute [rw] root_volume_configuration
|
@@ -1883,6 +1998,29 @@ module Aws::FSx
|
|
1883
1998
|
# the root volume.
|
1884
1999
|
# @return [Types::OpenZFSCreateRootVolumeConfiguration]
|
1885
2000
|
#
|
2001
|
+
# @!attribute [rw] preferred_subnet_id
|
2002
|
+
# Required when `DeploymentType` is set to `MULTI_AZ_1`. This
|
2003
|
+
# specifies the subnet in which you want the preferred file server to
|
2004
|
+
# be located.
|
2005
|
+
# @return [String]
|
2006
|
+
#
|
2007
|
+
# @!attribute [rw] endpoint_ip_address_range
|
2008
|
+
# (Multi-AZ only) Specifies the IP address range in which the
|
2009
|
+
# endpoints to access your file system will be created. By default in
|
2010
|
+
# the Amazon FSx API and Amazon FSx console, Amazon FSx selects an
|
2011
|
+
# available /28 IP address range for you from one of the VPC's CIDR
|
2012
|
+
# ranges. You can have overlapping endpoint IP addresses for file
|
2013
|
+
# systems deployed in the same VPC/route tables.
|
2014
|
+
# @return [String]
|
2015
|
+
#
|
2016
|
+
# @!attribute [rw] route_table_ids
|
2017
|
+
# (Multi-AZ only) Specifies the virtual private cloud (VPC) route
|
2018
|
+
# tables in which your file system's endpoints will be created. You
|
2019
|
+
# should specify all VPC route tables associated with the subnets in
|
2020
|
+
# which your clients are located. By default, Amazon FSx selects your
|
2021
|
+
# VPC's default route table.
|
2022
|
+
# @return [Array<String>]
|
2023
|
+
#
|
1886
2024
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemOpenZFSConfiguration AWS API Documentation
|
1887
2025
|
#
|
1888
2026
|
class CreateFileSystemOpenZFSConfiguration < Struct.new(
|
@@ -1894,7 +2032,10 @@ module Aws::FSx
|
|
1894
2032
|
:throughput_capacity,
|
1895
2033
|
:weekly_maintenance_start_time,
|
1896
2034
|
:disk_iops_configuration,
|
1897
|
-
:root_volume_configuration
|
2035
|
+
:root_volume_configuration,
|
2036
|
+
:preferred_subnet_id,
|
2037
|
+
:endpoint_ip_address_range,
|
2038
|
+
:route_table_ids)
|
1898
2039
|
SENSITIVE = []
|
1899
2040
|
include Aws::Structure
|
1900
2041
|
end
|
@@ -2254,6 +2395,14 @@ module Aws::FSx
|
|
2254
2395
|
# the Amazon FSx for Windows File Server file system.
|
2255
2396
|
# @return [Types::WindowsAuditLogCreateConfiguration]
|
2256
2397
|
#
|
2398
|
+
# @!attribute [rw] disk_iops_configuration
|
2399
|
+
# The SSD IOPS (input/output operations per second) configuration for
|
2400
|
+
# an Amazon FSx for Windows file system. By default, Amazon FSx
|
2401
|
+
# automatically provisions 3 IOPS per GiB of storage capacity. You can
|
2402
|
+
# provision additional IOPS per GiB of storage, up to the maximum
|
2403
|
+
# limit associated with your chosen throughput capacity.
|
2404
|
+
# @return [Types::DiskIopsConfiguration]
|
2405
|
+
#
|
2257
2406
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateFileSystemWindowsConfiguration AWS API Documentation
|
2258
2407
|
#
|
2259
2408
|
class CreateFileSystemWindowsConfiguration < Struct.new(
|
@@ -2267,7 +2416,8 @@ module Aws::FSx
|
|
2267
2416
|
:automatic_backup_retention_days,
|
2268
2417
|
:copy_tags_to_backups,
|
2269
2418
|
:aliases,
|
2270
|
-
:audit_log_configuration
|
2419
|
+
:audit_log_configuration,
|
2420
|
+
:disk_iops_configuration)
|
2271
2421
|
SENSITIVE = []
|
2272
2422
|
include Aws::Structure
|
2273
2423
|
end
|
@@ -2306,8 +2456,7 @@ module Aws::FSx
|
|
2306
2456
|
#
|
2307
2457
|
# @!attribute [rw] size_in_megabytes
|
2308
2458
|
# Specifies the size of the volume, in megabytes (MB), that you are
|
2309
|
-
# creating.
|
2310
|
-
# specify the size of the volume.
|
2459
|
+
# creating.
|
2311
2460
|
# @return [Integer]
|
2312
2461
|
#
|
2313
2462
|
# @!attribute [rw] storage_efficiency_enabled
|
@@ -2409,6 +2558,10 @@ module Aws::FSx
|
|
2409
2558
|
# volume, regardless of this value.
|
2410
2559
|
# @return [Boolean]
|
2411
2560
|
#
|
2561
|
+
# @!attribute [rw] snaplock_configuration
|
2562
|
+
# Specifies the SnapLock configuration for an FSx for ONTAP volume.
|
2563
|
+
# @return [Types::CreateSnaplockConfiguration]
|
2564
|
+
#
|
2412
2565
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateOntapVolumeConfiguration AWS API Documentation
|
2413
2566
|
#
|
2414
2567
|
class CreateOntapVolumeConfiguration < Struct.new(
|
@@ -2420,7 +2573,8 @@ module Aws::FSx
|
|
2420
2573
|
:tiering_policy,
|
2421
2574
|
:ontap_volume_type,
|
2422
2575
|
:snapshot_policy,
|
2423
|
-
:copy_tags_to_backups
|
2576
|
+
:copy_tags_to_backups,
|
2577
|
+
:snaplock_configuration)
|
2424
2578
|
SENSITIVE = []
|
2425
2579
|
include Aws::Structure
|
2426
2580
|
end
|
@@ -2591,6 +2745,97 @@ module Aws::FSx
|
|
2591
2745
|
include Aws::Structure
|
2592
2746
|
end
|
2593
2747
|
|
2748
|
+
# Defines the SnapLock configuration when creating an FSx for ONTAP
|
2749
|
+
# SnapLock volume.
|
2750
|
+
#
|
2751
|
+
# @!attribute [rw] audit_log_volume
|
2752
|
+
# Enables or disables the audit log volume for an FSx for ONTAP
|
2753
|
+
# SnapLock volume. The default value is `false`. If you set
|
2754
|
+
# `AuditLogVolume` to `true`, the SnapLock volume is created as an
|
2755
|
+
# audit log volume. The minimum retention period for an audit log
|
2756
|
+
# volume is six months.
|
2757
|
+
#
|
2758
|
+
# For more information, see [ SnapLock audit log volumes][1].
|
2759
|
+
#
|
2760
|
+
#
|
2761
|
+
#
|
2762
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume
|
2763
|
+
# @return [Boolean]
|
2764
|
+
#
|
2765
|
+
# @!attribute [rw] autocommit_period
|
2766
|
+
# The configuration object for setting the autocommit period of files
|
2767
|
+
# in an FSx for ONTAP SnapLock volume.
|
2768
|
+
# @return [Types::AutocommitPeriod]
|
2769
|
+
#
|
2770
|
+
# @!attribute [rw] privileged_delete
|
2771
|
+
# Enables, disables, or permanently disables privileged delete on an
|
2772
|
+
# FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete
|
2773
|
+
# allows SnapLock administrators to delete WORM files even if they
|
2774
|
+
# have active retention periods. `PERMANENTLY_DISABLED` is a terminal
|
2775
|
+
# state. If privileged delete is permanently disabled on a SnapLock
|
2776
|
+
# volume, you can't re-enable it. The default value is `DISABLED`.
|
2777
|
+
#
|
2778
|
+
# For more information, see [Privileged delete][1].
|
2779
|
+
#
|
2780
|
+
#
|
2781
|
+
#
|
2782
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete
|
2783
|
+
# @return [String]
|
2784
|
+
#
|
2785
|
+
# @!attribute [rw] retention_period
|
2786
|
+
# Specifies the retention period of an FSx for ONTAP SnapLock volume.
|
2787
|
+
# @return [Types::SnaplockRetentionPeriod]
|
2788
|
+
#
|
2789
|
+
# @!attribute [rw] snaplock_type
|
2790
|
+
# Specifies the retention mode of an FSx for ONTAP SnapLock volume.
|
2791
|
+
# After it is set, it can't be changed. You can choose one of the
|
2792
|
+
# following retention modes:
|
2793
|
+
#
|
2794
|
+
# * `COMPLIANCE`: Files transitioned to write once, read many (WORM)
|
2795
|
+
# on a Compliance volume can't be deleted until their retention
|
2796
|
+
# periods expire. This retention mode is used to address government
|
2797
|
+
# or industry-specific mandates or to protect against ransomware
|
2798
|
+
# attacks. For more information, see [SnapLock Compliance][1].
|
2799
|
+
#
|
2800
|
+
# * `ENTERPRISE`: Files transitioned to WORM on an Enterprise volume
|
2801
|
+
# can be deleted by authorized users before their retention periods
|
2802
|
+
# expire using privileged delete. This retention mode is used to
|
2803
|
+
# advance an organization's data integrity and internal compliance
|
2804
|
+
# or to test retention settings before using SnapLock Compliance.
|
2805
|
+
# For more information, see [SnapLock Enterprise][2].
|
2806
|
+
#
|
2807
|
+
#
|
2808
|
+
#
|
2809
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html
|
2810
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html
|
2811
|
+
# @return [String]
|
2812
|
+
#
|
2813
|
+
# @!attribute [rw] volume_append_mode_enabled
|
2814
|
+
# Enables or disables volume-append mode on an FSx for ONTAP SnapLock
|
2815
|
+
# volume. Volume-append mode allows you to create WORM-appendable
|
2816
|
+
# files and write data to them incrementally. The default value is
|
2817
|
+
# `false`.
|
2818
|
+
#
|
2819
|
+
# For more information, see [Volume-append mode][1].
|
2820
|
+
#
|
2821
|
+
#
|
2822
|
+
#
|
2823
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append
|
2824
|
+
# @return [Boolean]
|
2825
|
+
#
|
2826
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/CreateSnaplockConfiguration AWS API Documentation
|
2827
|
+
#
|
2828
|
+
class CreateSnaplockConfiguration < Struct.new(
|
2829
|
+
:audit_log_volume,
|
2830
|
+
:autocommit_period,
|
2831
|
+
:privileged_delete,
|
2832
|
+
:retention_period,
|
2833
|
+
:snaplock_type,
|
2834
|
+
:volume_append_mode_enabled)
|
2835
|
+
SENSITIVE = []
|
2836
|
+
include Aws::Structure
|
2837
|
+
end
|
2838
|
+
|
2594
2839
|
# @!attribute [rw] client_request_token
|
2595
2840
|
# (Optional) An idempotency token for resource creation, in a string
|
2596
2841
|
# of up to 63 ASCII characters. This token is automatically filled on
|
@@ -3211,10 +3456,24 @@ module Aws::FSx
|
|
3211
3456
|
include Aws::Structure
|
3212
3457
|
end
|
3213
3458
|
|
3214
|
-
# A description of the data repository task.
|
3215
|
-
#
|
3216
|
-
#
|
3217
|
-
#
|
3459
|
+
# A description of the data repository task.
|
3460
|
+
#
|
3461
|
+
# * You use import and export data repository tasks to perform bulk
|
3462
|
+
# transfer operations between an Amazon FSx for Lustre file system and
|
3463
|
+
# a linked data repository.
|
3464
|
+
#
|
3465
|
+
# * You use release data repository tasks to release archived files from
|
3466
|
+
# your Amazon FSx for Lustre file system.
|
3467
|
+
#
|
3468
|
+
# * An Amazon File Cache resource uses a task to automatically release
|
3469
|
+
# files from the cache.
|
3470
|
+
#
|
3471
|
+
# To learn more about data repository tasks, see [Data Repository
|
3472
|
+
# Tasks][1].
|
3473
|
+
#
|
3474
|
+
#
|
3475
|
+
#
|
3476
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-repository-tasks.html
|
3218
3477
|
#
|
3219
3478
|
# @!attribute [rw] task_id
|
3220
3479
|
# The system-generated, unique 17-digit ID of the data repository
|
@@ -3259,10 +3518,12 @@ module Aws::FSx
|
|
3259
3518
|
# * `IMPORT_METADATA_FROM_REPOSITORY` tasks import metadata changes
|
3260
3519
|
# from a linked S3 bucket to your Amazon FSx for Lustre file system.
|
3261
3520
|
#
|
3521
|
+
# * `RELEASE_DATA_FROM_FILESYSTEM` tasks release files in your Amazon
|
3522
|
+
# FSx for Lustre file system that are archived and that meet your
|
3523
|
+
# specified release criteria.
|
3524
|
+
#
|
3262
3525
|
# * `AUTO_RELEASE_DATA` tasks automatically release files from an
|
3263
3526
|
# Amazon File Cache resource.
|
3264
|
-
#
|
3265
|
-
# * `RELEASE_DATA_FROM_FILESYSTEM` tasks are not supported.
|
3266
3527
|
# @return [String]
|
3267
3528
|
#
|
3268
3529
|
# @!attribute [rw] creation_time
|
@@ -3337,6 +3598,12 @@ module Aws::FSx
|
|
3337
3598
|
# The system-generated, unique ID of the cache.
|
3338
3599
|
# @return [String]
|
3339
3600
|
#
|
3601
|
+
# @!attribute [rw] release_configuration
|
3602
|
+
# The configuration that specifies the last accessed time criteria for
|
3603
|
+
# files that will be released from an Amazon FSx for Lustre file
|
3604
|
+
# system.
|
3605
|
+
# @return [Types::ReleaseConfiguration]
|
3606
|
+
#
|
3340
3607
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DataRepositoryTask AWS API Documentation
|
3341
3608
|
#
|
3342
3609
|
class DataRepositoryTask < Struct.new(
|
@@ -3354,7 +3621,8 @@ module Aws::FSx
|
|
3354
3621
|
:status,
|
3355
3622
|
:report,
|
3356
3623
|
:capacity_to_release,
|
3357
|
-
:file_cache_id
|
3624
|
+
:file_cache_id,
|
3625
|
+
:release_configuration)
|
3358
3626
|
SENSITIVE = []
|
3359
3627
|
include Aws::Structure
|
3360
3628
|
end
|
@@ -3946,8 +4214,9 @@ module Aws::FSx
|
|
3946
4214
|
include Aws::Structure
|
3947
4215
|
end
|
3948
4216
|
|
3949
|
-
# Use to specify skipping a final backup,
|
3950
|
-
#
|
4217
|
+
# Use to specify skipping a final backup, adding tags to a final backup,
|
4218
|
+
# or bypassing the retention period of an FSx for ONTAP SnapLock
|
4219
|
+
# Enterprise volume when deleting an FSx for ONTAP volume.
|
3951
4220
|
#
|
3952
4221
|
# @!attribute [rw] skip_final_backup
|
3953
4222
|
# Set to true if you want to skip taking a final backup of the volume
|
@@ -3958,11 +4227,27 @@ module Aws::FSx
|
|
3958
4227
|
# A list of `Tag` values, with a maximum of 50 elements.
|
3959
4228
|
# @return [Array<Types::Tag>]
|
3960
4229
|
#
|
4230
|
+
# @!attribute [rw] bypass_snaplock_enterprise_retention
|
4231
|
+
# Setting this to `true` allows a SnapLock administrator to delete an
|
4232
|
+
# FSx for ONTAP SnapLock Enterprise volume with unexpired write once,
|
4233
|
+
# read many (WORM) files. The IAM permission
|
4234
|
+
# `fsx:BypassSnaplockEnterpriseRetention` is also required to delete
|
4235
|
+
# SnapLock Enterprise volumes with unexpired WORM files. The default
|
4236
|
+
# value is `false`.
|
4237
|
+
#
|
4238
|
+
# For more information, see [ Deleting a SnapLock volume][1].
|
4239
|
+
#
|
4240
|
+
#
|
4241
|
+
#
|
4242
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-delete-volume.html
|
4243
|
+
# @return [Boolean]
|
4244
|
+
#
|
3961
4245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolumeOntapConfiguration AWS API Documentation
|
3962
4246
|
#
|
3963
4247
|
class DeleteVolumeOntapConfiguration < Struct.new(
|
3964
4248
|
:skip_final_backup,
|
3965
|
-
:final_backup_tags
|
4249
|
+
:final_backup_tags,
|
4250
|
+
:bypass_snaplock_enterprise_retention)
|
3966
4251
|
SENSITIVE = []
|
3967
4252
|
include Aws::Structure
|
3968
4253
|
end
|
@@ -4603,12 +4888,12 @@ module Aws::FSx
|
|
4603
4888
|
end
|
4604
4889
|
|
4605
4890
|
# The SSD IOPS (input/output operations per second) configuration for an
|
4606
|
-
# Amazon FSx for NetApp ONTAP
|
4607
|
-
#
|
4608
|
-
#
|
4609
|
-
#
|
4610
|
-
#
|
4611
|
-
# FSx).
|
4891
|
+
# Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or
|
4892
|
+
# FSx for OpenZFS file system. By default, Amazon FSx automatically
|
4893
|
+
# provisions 3 IOPS per GB of storage capacity. You can provision
|
4894
|
+
# additional IOPS per GB of storage. The configuration consists of the
|
4895
|
+
# total number of provisioned SSD IOPS and how it is was provisioned, or
|
4896
|
+
# the mode (by the customer or by Amazon FSx).
|
4612
4897
|
#
|
4613
4898
|
# @!attribute [rw] mode
|
4614
4899
|
# Specifies whether the file system is using the `AUTOMATIC` setting
|
@@ -4629,6 +4914,41 @@ module Aws::FSx
|
|
4629
4914
|
include Aws::Structure
|
4630
4915
|
end
|
4631
4916
|
|
4917
|
+
# Defines the minimum amount of time since last access for a file to be
|
4918
|
+
# eligible for release. Only archived files that were last accessed or
|
4919
|
+
# modified before this point-in-time are eligible to be released from
|
4920
|
+
# the Amazon FSx for Lustre file system.
|
4921
|
+
#
|
4922
|
+
# @!attribute [rw] unit
|
4923
|
+
# The unit of time used by the `Value` parameter to determine if a
|
4924
|
+
# file can be released, based on when it was last accessed. `DAYS` is
|
4925
|
+
# the only supported value. This is a required parameter.
|
4926
|
+
# @return [String]
|
4927
|
+
#
|
4928
|
+
# @!attribute [rw] value
|
4929
|
+
# An integer that represents the minimum amount of time (in days)
|
4930
|
+
# since a file was last accessed in the file system. Only archived
|
4931
|
+
# files with a `MAX(atime, ctime, mtime)` timestamp that is more than
|
4932
|
+
# this amount of time in the past (relative to the task create time)
|
4933
|
+
# will be released. The default of `Value` is `0`. This is a required
|
4934
|
+
# parameter.
|
4935
|
+
#
|
4936
|
+
# <note markdown="1"> If an archived file meets the last accessed time criteria, its file
|
4937
|
+
# or directory path must also be specified in the `Paths` parameter of
|
4938
|
+
# the operation in order for the file to be released.
|
4939
|
+
#
|
4940
|
+
# </note>
|
4941
|
+
# @return [Integer]
|
4942
|
+
#
|
4943
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DurationSinceLastAccess AWS API Documentation
|
4944
|
+
#
|
4945
|
+
class DurationSinceLastAccess < Struct.new(
|
4946
|
+
:unit,
|
4947
|
+
:value)
|
4948
|
+
SENSITIVE = []
|
4949
|
+
include Aws::Structure
|
4950
|
+
end
|
4951
|
+
|
4632
4952
|
# A description of a specific Amazon File Cache resource, which is a
|
4633
4953
|
# response object from the `DescribeFileCaches` operation.
|
4634
4954
|
#
|
@@ -6264,6 +6584,11 @@ module Aws::FSx
|
|
6264
6584
|
# volume, regardless of this value.
|
6265
6585
|
# @return [Boolean]
|
6266
6586
|
#
|
6587
|
+
# @!attribute [rw] snaplock_configuration
|
6588
|
+
# The SnapLock configuration object for an FSx for ONTAP SnapLock
|
6589
|
+
# volume.
|
6590
|
+
# @return [Types::SnaplockConfiguration]
|
6591
|
+
#
|
6267
6592
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OntapVolumeConfiguration AWS API Documentation
|
6268
6593
|
#
|
6269
6594
|
class OntapVolumeConfiguration < Struct.new(
|
@@ -6278,7 +6603,8 @@ module Aws::FSx
|
|
6278
6603
|
:uuid,
|
6279
6604
|
:ontap_volume_type,
|
6280
6605
|
:snapshot_policy,
|
6281
|
-
:copy_tags_to_backups
|
6606
|
+
:copy_tags_to_backups,
|
6607
|
+
:snaplock_configuration)
|
6282
6608
|
SENSITIVE = []
|
6283
6609
|
include Aws::Structure
|
6284
6610
|
end
|
@@ -6432,7 +6758,7 @@ module Aws::FSx
|
|
6432
6758
|
#
|
6433
6759
|
# @!attribute [rw] deployment_type
|
6434
6760
|
# Specifies the file-system deployment type. Amazon FSx for OpenZFS
|
6435
|
-
# supports
`SINGLE_AZ_1
|
6761
|
+
# supports
`MULTI_AZ_1`, `SINGLE_AZ_1`, and `SINGLE_AZ_2`.
|
6436
6762
|
# @return [String]
|
6437
6763
|
#
|
6438
6764
|
# @!attribute [rw] throughput_capacity
|
@@ -6459,18 +6785,43 @@ module Aws::FSx
|
|
6459
6785
|
#
|
6460
6786
|
# @!attribute [rw] disk_iops_configuration
|
6461
6787
|
# The SSD IOPS (input/output operations per second) configuration for
|
6462
|
-
# an Amazon FSx for NetApp ONTAP
|
6463
|
-
#
|
6464
|
-
# storage capacity. You can provision
|
6465
|
-
# storage. The configuration consists of the
|
6466
|
-
# provisioned SSD IOPS and how it is was provisioned,
|
6467
|
-
# the customer or by Amazon FSx).
|
6788
|
+
# an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server,
|
6789
|
+
# or FSx for OpenZFS file system. By default, Amazon FSx automatically
|
6790
|
+
# provisions 3 IOPS per GB of storage capacity. You can provision
|
6791
|
+
# additional IOPS per GB of storage. The configuration consists of the
|
6792
|
+
# total number of provisioned SSD IOPS and how it is was provisioned,
|
6793
|
+
# or the mode (by the customer or by Amazon FSx).
|
6468
6794
|
# @return [Types::DiskIopsConfiguration]
|
6469
6795
|
#
|
6470
6796
|
# @!attribute [rw] root_volume_id
|
6471
6797
|
# The ID of the root volume of the OpenZFS file system.
|
6472
6798
|
# @return [String]
|
6473
6799
|
#
|
6800
|
+
# @!attribute [rw] preferred_subnet_id
|
6801
|
+
# Required when `DeploymentType` is set to `MULTI_AZ_1`. This
|
6802
|
+
# specifies the subnet in which you want the preferred file server to
|
6803
|
+
# be located.
|
6804
|
+
# @return [String]
|
6805
|
+
#
|
6806
|
+
# @!attribute [rw] endpoint_ip_address_range
|
6807
|
+
# (Multi-AZ only) Specifies the IP address range in which the
|
6808
|
+
# endpoints to access your file system will be created. By default in
|
6809
|
+
# the Amazon FSx API and Amazon FSx console, Amazon FSx selects an
|
6810
|
+
# available /28 IP address range for you from one of the VPC's CIDR
|
6811
|
+
# ranges. You can have overlapping endpoint IP addresses for file
|
6812
|
+
# systems deployed in the same VPC/route tables.
|
6813
|
+
# @return [String]
|
6814
|
+
#
|
6815
|
+
# @!attribute [rw] route_table_ids
|
6816
|
+
# (Multi-AZ only) The VPC route tables in which your file system's
|
6817
|
+
# endpoints are created.
|
6818
|
+
# @return [Array<String>]
|
6819
|
+
#
|
6820
|
+
# @!attribute [rw] endpoint_ip_address
|
6821
|
+
# The IP address of the endpoint that is used to access data or to
|
6822
|
+
# manage the file system.
|
6823
|
+
# @return [String]
|
6824
|
+
#
|
6474
6825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/OpenZFSFileSystemConfiguration AWS API Documentation
|
6475
6826
|
#
|
6476
6827
|
class OpenZFSFileSystemConfiguration < Struct.new(
|
@@ -6482,7 +6833,11 @@ module Aws::FSx
|
|
6482
6833
|
:throughput_capacity,
|
6483
6834
|
:weekly_maintenance_start_time,
|
6484
6835
|
:disk_iops_configuration,
|
6485
|
-
:root_volume_id
|
6836
|
+
:root_volume_id,
|
6837
|
+
:preferred_subnet_id,
|
6838
|
+
:endpoint_ip_address_range,
|
6839
|
+
:route_table_ids,
|
6840
|
+
:endpoint_ip_address)
|
6486
6841
|
SENSITIVE = []
|
6487
6842
|
include Aws::Structure
|
6488
6843
|
end
|
@@ -6680,6 +7035,42 @@ module Aws::FSx
|
|
6680
7035
|
include Aws::Structure
|
6681
7036
|
end
|
6682
7037
|
|
7038
|
+
# The configuration that specifies a minimum amount of time since last
|
7039
|
+
# access for an archived file to be eligible for release from an Amazon
|
7040
|
+
# FSx for Lustre file system. Only files that were last accessed before
|
7041
|
+
# this point-in-time can be released. For example, if you specify a last
|
7042
|
+
# accessed time criteria of 9 days, only files that were last accessed
|
7043
|
+
# 9.00001 or more days ago can be released.
|
7044
|
+
#
|
7045
|
+
# Only file data that has been archived can be released. Files that have
|
7046
|
+
# not yet been archived, such as new or changed files that have not been
|
7047
|
+
# exported, are not eligible for release. When files are released, their
|
7048
|
+
# metadata stays on the file system, so they can still be accessed
|
7049
|
+
# later. Users and applications can access a released file by reading
|
7050
|
+
# the file again, which restores data from Amazon S3 to the FSx for
|
7051
|
+
# Lustre file system.
|
7052
|
+
#
|
7053
|
+
# <note markdown="1"> If a file meets the last accessed time criteria, its file or directory
|
7054
|
+
# path must also be specified with the `Paths` parameter of the
|
7055
|
+
# operation in order for the file to be released.
|
7056
|
+
#
|
7057
|
+
# </note>
|
7058
|
+
#
|
7059
|
+
# @!attribute [rw] duration_since_last_access
|
7060
|
+
# Defines the point-in-time since an archived file was last accessed,
|
7061
|
+
# in order for that file to be eligible for release. Only files that
|
7062
|
+
# were last accessed before this point-in-time are eligible to be
|
7063
|
+
# released from the file system.
|
7064
|
+
# @return [Types::DurationSinceLastAccess]
|
7065
|
+
#
|
7066
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/ReleaseConfiguration AWS API Documentation
|
7067
|
+
#
|
7068
|
+
class ReleaseConfiguration < Struct.new(
|
7069
|
+
:duration_since_last_access)
|
7070
|
+
SENSITIVE = []
|
7071
|
+
include Aws::Structure
|
7072
|
+
end
|
7073
|
+
|
6683
7074
|
# @!attribute [rw] file_system_id
|
6684
7075
|
# The globally unique ID of the file system, assigned by Amazon FSx.
|
6685
7076
|
# @return [String]
|
@@ -6823,6 +7214,53 @@ module Aws::FSx
|
|
6823
7214
|
include Aws::Structure
|
6824
7215
|
end
|
6825
7216
|
|
7217
|
+
# Specifies the retention period of an FSx for ONTAP SnapLock volume.
|
7218
|
+
# After it is set, it can't be changed. Files can't be deleted or
|
7219
|
+
# modified during the retention period.
|
7220
|
+
#
|
7221
|
+
# For more information, see [Working with the retention period in
|
7222
|
+
# SnapLock][1].
|
7223
|
+
#
|
7224
|
+
#
|
7225
|
+
#
|
7226
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html
|
7227
|
+
#
|
7228
|
+
# @!attribute [rw] type
|
7229
|
+
# Defines the type of time for the retention period of an FSx for
|
7230
|
+
# ONTAP SnapLock volume. Set it to one of the valid types. If you set
|
7231
|
+
# it to `INFINITE`, the files are retained forever. If you set it to
|
7232
|
+
# `UNSPECIFIED`, the files are retained until you set an explicit
|
7233
|
+
# retention period.
|
7234
|
+
# @return [String]
|
7235
|
+
#
|
7236
|
+
# @!attribute [rw] value
|
7237
|
+
# Defines the amount of time for the retention period of an FSx for
|
7238
|
+
# ONTAP SnapLock volume. You can't set a value for `INFINITE` or
|
7239
|
+
# `UNSPECIFIED`. For all other options, the following ranges are
|
7240
|
+
# valid:
|
7241
|
+
#
|
7242
|
+
# * `Seconds`: 0 - 65,535
|
7243
|
+
#
|
7244
|
+
# * `Minutes`: 0 - 65,535
|
7245
|
+
#
|
7246
|
+
# * `Hours`: 0 - 24
|
7247
|
+
#
|
7248
|
+
# * `Days`: 0 - 365
|
7249
|
+
#
|
7250
|
+
# * `Months`: 0 - 12
|
7251
|
+
#
|
7252
|
+
# * `Years`: 0 - 100
|
7253
|
+
# @return [Integer]
|
7254
|
+
#
|
7255
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/RetentionPeriod AWS API Documentation
|
7256
|
+
#
|
7257
|
+
class RetentionPeriod < Struct.new(
|
7258
|
+
:type,
|
7259
|
+
:value)
|
7260
|
+
SENSITIVE = []
|
7261
|
+
include Aws::Structure
|
7262
|
+
end
|
7263
|
+
|
6826
7264
|
# The configuration for an Amazon S3 data repository linked to an Amazon
|
6827
7265
|
# FSx for Lustre file system with a data repository association. The
|
6828
7266
|
# configuration consists of an `AutoImportPolicy` that defines which
|
@@ -7050,6 +7488,135 @@ module Aws::FSx
|
|
7050
7488
|
include Aws::Structure
|
7051
7489
|
end
|
7052
7490
|
|
7491
|
+
# Specifies the SnapLock configuration for an FSx for ONTAP SnapLock
|
7492
|
+
# volume.
|
7493
|
+
#
|
7494
|
+
# @!attribute [rw] audit_log_volume
|
7495
|
+
# Enables or disables the audit log volume for an FSx for ONTAP
|
7496
|
+
# SnapLock volume. The default value is `false`. If you set
|
7497
|
+
# `AuditLogVolume` to `true`, the SnapLock volume is created as an
|
7498
|
+
# audit log volume. The minimum retention period for an audit log
|
7499
|
+
# volume is six months.
|
7500
|
+
#
|
7501
|
+
# For more information, see [ SnapLock audit log volumes][1].
|
7502
|
+
#
|
7503
|
+
#
|
7504
|
+
#
|
7505
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume
|
7506
|
+
# @return [Boolean]
|
7507
|
+
#
|
7508
|
+
# @!attribute [rw] autocommit_period
|
7509
|
+
# The configuration object for setting the autocommit period of files
|
7510
|
+
# in an FSx for ONTAP SnapLock volume.
|
7511
|
+
# @return [Types::AutocommitPeriod]
|
7512
|
+
#
|
7513
|
+
# @!attribute [rw] privileged_delete
|
7514
|
+
# Enables, disables, or permanently disables privileged delete on an
|
7515
|
+
# FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete
|
7516
|
+
# allows SnapLock administrators to delete write once, read many
|
7517
|
+
# (WORM) files even if they have active retention periods.
|
7518
|
+
# `PERMANENTLY_DISABLED` is a terminal state. If privileged delete is
|
7519
|
+
# permanently disabled on a SnapLock volume, you can't re-enable it.
|
7520
|
+
# The default value is `DISABLED`.
|
7521
|
+
#
|
7522
|
+
# For more information, see [Privileged delete][1].
|
7523
|
+
#
|
7524
|
+
#
|
7525
|
+
#
|
7526
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete
|
7527
|
+
# @return [String]
|
7528
|
+
#
|
7529
|
+
# @!attribute [rw] retention_period
|
7530
|
+
# Specifies the retention period of an FSx for ONTAP SnapLock volume.
|
7531
|
+
# @return [Types::SnaplockRetentionPeriod]
|
7532
|
+
#
|
7533
|
+
# @!attribute [rw] snaplock_type
|
7534
|
+
# Specifies the retention mode of an FSx for ONTAP SnapLock volume.
|
7535
|
+
# After it is set, it can't be changed. You can choose one of the
|
7536
|
+
# following retention modes:
|
7537
|
+
#
|
7538
|
+
# * `COMPLIANCE`: Files transitioned to write once, read many (WORM)
|
7539
|
+
# on a Compliance volume can't be deleted until their retention
|
7540
|
+
# periods expire. This retention mode is used to address government
|
7541
|
+
# or industry-specific mandates or to protect against ransomware
|
7542
|
+
# attacks. For more information, see [SnapLock Compliance][1].
|
7543
|
+
#
|
7544
|
+
# * `ENTERPRISE`: Files transitioned to WORM on an Enterprise volume
|
7545
|
+
# can be deleted by authorized users before their retention periods
|
7546
|
+
# expire using privileged delete. This retention mode is used to
|
7547
|
+
# advance an organization's data integrity and internal compliance
|
7548
|
+
# or to test retention settings before using SnapLock Compliance.
|
7549
|
+
# For more information, see [SnapLock Enterprise][2].
|
7550
|
+
#
|
7551
|
+
#
|
7552
|
+
#
|
7553
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-compliance.html
|
7554
|
+
# [2]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html
|
7555
|
+
# @return [String]
|
7556
|
+
#
|
7557
|
+
# @!attribute [rw] volume_append_mode_enabled
|
7558
|
+
# Enables or disables volume-append mode on an FSx for ONTAP SnapLock
|
7559
|
+
# volume. Volume-append mode allows you to create WORM-appendable
|
7560
|
+
# files and write data to them incrementally. The default value is
|
7561
|
+
# `false`.
|
7562
|
+
#
|
7563
|
+
# For more information, see [Volume-append mode][1].
|
7564
|
+
#
|
7565
|
+
#
|
7566
|
+
#
|
7567
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append
|
7568
|
+
# @return [Boolean]
|
7569
|
+
#
|
7570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SnaplockConfiguration AWS API Documentation
|
7571
|
+
#
|
7572
|
+
class SnaplockConfiguration < Struct.new(
|
7573
|
+
:audit_log_volume,
|
7574
|
+
:autocommit_period,
|
7575
|
+
:privileged_delete,
|
7576
|
+
:retention_period,
|
7577
|
+
:snaplock_type,
|
7578
|
+
:volume_append_mode_enabled)
|
7579
|
+
SENSITIVE = []
|
7580
|
+
include Aws::Structure
|
7581
|
+
end
|
7582
|
+
|
7583
|
+
# The configuration to set the retention period of an FSx for ONTAP
|
7584
|
+
# SnapLock volume. The retention period includes default, maximum, and
|
7585
|
+
# minimum settings. For more information, see [Working with the
|
7586
|
+
# retention period in SnapLock][1].
|
7587
|
+
#
|
7588
|
+
#
|
7589
|
+
#
|
7590
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-retention.html
|
7591
|
+
#
|
7592
|
+
# @!attribute [rw] default_retention
|
7593
|
+
# The retention period assigned to a write once, read many (WORM) file
|
7594
|
+
# by default if an explicit retention period is not set for an FSx for
|
7595
|
+
# ONTAP SnapLock volume. The default retention period must be greater
|
7596
|
+
# than or equal to the minimum retention period and less than or equal
|
7597
|
+
# to the maximum retention period.
|
7598
|
+
# @return [Types::RetentionPeriod]
|
7599
|
+
#
|
7600
|
+
# @!attribute [rw] minimum_retention
|
7601
|
+
# The shortest retention period that can be assigned to a WORM file on
|
7602
|
+
# an FSx for ONTAP SnapLock volume.
|
7603
|
+
# @return [Types::RetentionPeriod]
|
7604
|
+
#
|
7605
|
+
# @!attribute [rw] maximum_retention
|
7606
|
+
# The longest retention period that can be assigned to a WORM file on
|
7607
|
+
# an FSx for ONTAP SnapLock volume.
|
7608
|
+
# @return [Types::RetentionPeriod]
|
7609
|
+
#
|
7610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/SnaplockRetentionPeriod AWS API Documentation
|
7611
|
+
#
|
7612
|
+
class SnaplockRetentionPeriod < Struct.new(
|
7613
|
+
:default_retention,
|
7614
|
+
:minimum_retention,
|
7615
|
+
:maximum_retention)
|
7616
|
+
SENSITIVE = []
|
7617
|
+
include Aws::Structure
|
7618
|
+
end
|
7619
|
+
|
7053
7620
|
# A snapshot of an Amazon FSx for OpenZFS volume.
|
7054
7621
|
#
|
7055
7622
|
# @!attribute [rw] resource_arn
|
@@ -7940,14 +8507,27 @@ module Aws::FSx
|
|
7940
8507
|
#
|
7941
8508
|
# @!attribute [rw] disk_iops_configuration
|
7942
8509
|
# The SSD IOPS (input/output operations per second) configuration for
|
7943
|
-
# an Amazon FSx for NetApp ONTAP
|
7944
|
-
#
|
7945
|
-
# storage capacity. You can provision
|
7946
|
-
# storage. The configuration consists of the
|
7947
|
-
# provisioned SSD IOPS and how it is was provisioned,
|
7948
|
-
# the customer or by Amazon FSx).
|
8510
|
+
# an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server,
|
8511
|
+
# or FSx for OpenZFS file system. By default, Amazon FSx automatically
|
8512
|
+
# provisions 3 IOPS per GB of storage capacity. You can provision
|
8513
|
+
# additional IOPS per GB of storage. The configuration consists of the
|
8514
|
+
# total number of provisioned SSD IOPS and how it is was provisioned,
|
8515
|
+
# or the mode (by the customer or by Amazon FSx).
|
7949
8516
|
# @return [Types::DiskIopsConfiguration]
|
7950
8517
|
#
|
8518
|
+
# @!attribute [rw] add_route_table_ids
|
8519
|
+
# (Multi-AZ only) A list of IDs of new virtual private cloud (VPC)
|
8520
|
+
# route tables to associate (add) with your Amazon FSx for OpenZFS
|
8521
|
+
# file system.
|
8522
|
+
# @return [Array<String>]
|
8523
|
+
#
|
8524
|
+
# @!attribute [rw] remove_route_table_ids
|
8525
|
+
# (Multi-AZ only) A list of IDs of existing virtual private cloud
|
8526
|
+
# (VPC) route tables to disassociate (remove) from your Amazon FSx for
|
8527
|
+
# OpenZFS file system. You can use the API operation to retrieve the
|
8528
|
+
# list of VPC route table IDs for a file system.
|
8529
|
+
# @return [Array<String>]
|
8530
|
+
#
|
7951
8531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemOpenZFSConfiguration AWS API Documentation
|
7952
8532
|
#
|
7953
8533
|
class UpdateFileSystemOpenZFSConfiguration < Struct.new(
|
@@ -7957,7 +8537,9 @@ module Aws::FSx
|
|
7957
8537
|
:daily_automatic_backup_start_time,
|
7958
8538
|
:throughput_capacity,
|
7959
8539
|
:weekly_maintenance_start_time,
|
7960
|
-
:disk_iops_configuration
|
8540
|
+
:disk_iops_configuration,
|
8541
|
+
:add_route_table_ids,
|
8542
|
+
:remove_route_table_ids)
|
7961
8543
|
SENSITIVE = []
|
7962
8544
|
include Aws::Structure
|
7963
8545
|
end
|
@@ -8052,6 +8634,10 @@ module Aws::FSx
|
|
8052
8634
|
# The configuration updates for an FSx for OpenZFS file system.
|
8053
8635
|
# @return [Types::UpdateFileSystemOpenZFSConfiguration]
|
8054
8636
|
#
|
8637
|
+
# @!attribute [rw] storage_type
|
8638
|
+
# Specifies the file system's storage type.
|
8639
|
+
# @return [String]
|
8640
|
+
#
|
8055
8641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemRequest AWS API Documentation
|
8056
8642
|
#
|
8057
8643
|
class UpdateFileSystemRequest < Struct.new(
|
@@ -8061,7 +8647,8 @@ module Aws::FSx
|
|
8061
8647
|
:windows_configuration,
|
8062
8648
|
:lustre_configuration,
|
8063
8649
|
:ontap_configuration,
|
8064
|
-
:open_zfs_configuration
|
8650
|
+
:open_zfs_configuration,
|
8651
|
+
:storage_type)
|
8065
8652
|
SENSITIVE = []
|
8066
8653
|
include Aws::Structure
|
8067
8654
|
end
|
@@ -8132,6 +8719,14 @@ module Aws::FSx
|
|
8132
8719
|
# the Amazon FSx for Windows File Server file system..
|
8133
8720
|
# @return [Types::WindowsAuditLogCreateConfiguration]
|
8134
8721
|
#
|
8722
|
+
# @!attribute [rw] disk_iops_configuration
|
8723
|
+
# The SSD IOPS (input/output operations per second) configuration for
|
8724
|
+
# an Amazon FSx for Windows file system. By default, Amazon FSx
|
8725
|
+
# automatically provisions 3 IOPS per GiB of storage capacity. You can
|
8726
|
+
# provision additional IOPS per GiB of storage, up to the maximum
|
8727
|
+
# limit associated with your chosen throughput capacity.
|
8728
|
+
# @return [Types::DiskIopsConfiguration]
|
8729
|
+
#
|
8135
8730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateFileSystemWindowsConfiguration AWS API Documentation
|
8136
8731
|
#
|
8137
8732
|
class UpdateFileSystemWindowsConfiguration < Struct.new(
|
@@ -8140,7 +8735,8 @@ module Aws::FSx
|
|
8140
8735
|
:automatic_backup_retention_days,
|
8141
8736
|
:throughput_capacity,
|
8142
8737
|
:self_managed_active_directory_configuration,
|
8143
|
-
:audit_log_configuration
|
8738
|
+
:audit_log_configuration,
|
8739
|
+
:disk_iops_configuration)
|
8144
8740
|
SENSITIVE = []
|
8145
8741
|
include Aws::Structure
|
8146
8742
|
end
|
@@ -8155,7 +8751,7 @@ module Aws::FSx
|
|
8155
8751
|
# @return [String]
|
8156
8752
|
#
|
8157
8753
|
# @!attribute [rw] security_style
|
8158
|
-
# The security style for the volume, which can be `UNIX
|
8754
|
+
# The security style for the volume, which can be `UNIX`, `NTFS`, or
|
8159
8755
|
# `MIXED`.
|
8160
8756
|
# @return [String]
|
8161
8757
|
#
|
@@ -8212,6 +8808,11 @@ module Aws::FSx
|
|
8212
8808
|
# volume, regardless of this value.
|
8213
8809
|
# @return [Boolean]
|
8214
8810
|
#
|
8811
|
+
# @!attribute [rw] snaplock_configuration
|
8812
|
+
# The configuration object for updating the SnapLock configuration of
|
8813
|
+
# an FSx for ONTAP SnapLock volume.
|
8814
|
+
# @return [Types::UpdateSnaplockConfiguration]
|
8815
|
+
#
|
8215
8816
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateOntapVolumeConfiguration AWS API Documentation
|
8216
8817
|
#
|
8217
8818
|
class UpdateOntapVolumeConfiguration < Struct.new(
|
@@ -8221,7 +8822,8 @@ module Aws::FSx
|
|
8221
8822
|
:storage_efficiency_enabled,
|
8222
8823
|
:tiering_policy,
|
8223
8824
|
:snapshot_policy,
|
8224
|
-
:copy_tags_to_backups
|
8825
|
+
:copy_tags_to_backups,
|
8826
|
+
:snaplock_configuration)
|
8225
8827
|
SENSITIVE = []
|
8226
8828
|
include Aws::Structure
|
8227
8829
|
end
|
@@ -8303,6 +8905,73 @@ module Aws::FSx
|
|
8303
8905
|
include Aws::Structure
|
8304
8906
|
end
|
8305
8907
|
|
8908
|
+
# Updates the SnapLock configuration for an existing FSx for ONTAP
|
8909
|
+
# volume.
|
8910
|
+
#
|
8911
|
+
# @!attribute [rw] audit_log_volume
|
8912
|
+
# Enables or disables the audit log volume for an FSx for ONTAP
|
8913
|
+
# SnapLock volume. The default value is `false`. If you set
|
8914
|
+
# `AuditLogVolume` to `true`, the SnapLock volume is created as an
|
8915
|
+
# audit log volume. The minimum retention period for an audit log
|
8916
|
+
# volume is six months.
|
8917
|
+
#
|
8918
|
+
# For more information, see [ SnapLock audit log volumes][1].
|
8919
|
+
#
|
8920
|
+
#
|
8921
|
+
#
|
8922
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/how-snaplock-works.html#snaplock-audit-log-volume
|
8923
|
+
# @return [Boolean]
|
8924
|
+
#
|
8925
|
+
# @!attribute [rw] autocommit_period
|
8926
|
+
# The configuration object for setting the autocommit period of files
|
8927
|
+
# in an FSx for ONTAP SnapLock volume.
|
8928
|
+
# @return [Types::AutocommitPeriod]
|
8929
|
+
#
|
8930
|
+
# @!attribute [rw] privileged_delete
|
8931
|
+
# Enables, disables, or permanently disables privileged delete on an
|
8932
|
+
# FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete
|
8933
|
+
# allows SnapLock administrators to delete write once, read many
|
8934
|
+
# (WORM) files even if they have active retention periods.
|
8935
|
+
# `PERMANENTLY_DISABLED` is a terminal state. If privileged delete is
|
8936
|
+
# permanently disabled on a SnapLock volume, you can't re-enable it.
|
8937
|
+
# The default value is `DISABLED`.
|
8938
|
+
#
|
8939
|
+
# For more information, see [Privileged delete][1].
|
8940
|
+
#
|
8941
|
+
#
|
8942
|
+
#
|
8943
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/snaplock-enterprise.html#privileged-delete
|
8944
|
+
# @return [String]
|
8945
|
+
#
|
8946
|
+
# @!attribute [rw] retention_period
|
8947
|
+
# Specifies the retention period of an FSx for ONTAP SnapLock volume.
|
8948
|
+
# @return [Types::SnaplockRetentionPeriod]
|
8949
|
+
#
|
8950
|
+
# @!attribute [rw] volume_append_mode_enabled
|
8951
|
+
# Enables or disables volume-append mode on an FSx for ONTAP SnapLock
|
8952
|
+
# volume. Volume-append mode allows you to create WORM-appendable
|
8953
|
+
# files and write data to them incrementally. The default value is
|
8954
|
+
# `false`.
|
8955
|
+
#
|
8956
|
+
# For more information, see [Volume-append mode][1].
|
8957
|
+
#
|
8958
|
+
#
|
8959
|
+
#
|
8960
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/worm-state.html#worm-state-append
|
8961
|
+
# @return [Boolean]
|
8962
|
+
#
|
8963
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateSnaplockConfiguration AWS API Documentation
|
8964
|
+
#
|
8965
|
+
class UpdateSnaplockConfiguration < Struct.new(
|
8966
|
+
:audit_log_volume,
|
8967
|
+
:autocommit_period,
|
8968
|
+
:privileged_delete,
|
8969
|
+
:retention_period,
|
8970
|
+
:volume_append_mode_enabled)
|
8971
|
+
SENSITIVE = []
|
8972
|
+
include Aws::Structure
|
8973
|
+
end
|
8974
|
+
|
8306
8975
|
# @!attribute [rw] client_request_token
|
8307
8976
|
# (Optional) An idempotency token for resource creation, in a string
|
8308
8977
|
# of up to 63 ASCII characters. This token is automatically filled on
|
@@ -8652,7 +9321,7 @@ module Aws::FSx
|
|
8652
9321
|
# ARN or Amazon Kinesis Data Firehose delivery stream ARN.
|
8653
9322
|
#
|
8654
9323
|
# The name of the Amazon CloudWatch Logs log group must begin with the
|
8655
|
-
# `/aws/fsx` prefix. The name of the Amazon Kinesis Data
|
9324
|
+
# `/aws/fsx` prefix. The name of the Amazon Kinesis Data Firehose
|
8656
9325
|
# delivery stream must begin with the `aws-fsx` prefix.
|
8657
9326
|
#
|
8658
9327
|
# The destination ARN (either CloudWatch Logs log group or Kinesis
|
@@ -8721,7 +9390,7 @@ module Aws::FSx
|
|
8721
9390
|
#
|
8722
9391
|
# * The name of the Amazon CloudWatch Logs log group must begin with
|
8723
9392
|
# the `/aws/fsx` prefix. The name of the Amazon Kinesis Data
|
8724
|
-
#
|
9393
|
+
# Firehose delivery stream must begin with the `aws-fsx` prefix.
|
8725
9394
|
#
|
8726
9395
|
# * If you do not provide a destination in `AuditLogDestination`,
|
8727
9396
|
# Amazon FSx will create and use a log stream in the CloudWatch Logs
|
@@ -8888,6 +9557,14 @@ module Aws::FSx
|
|
8888
9557
|
# the Amazon FSx for Windows File Server file system.
|
8889
9558
|
# @return [Types::WindowsAuditLogConfiguration]
|
8890
9559
|
#
|
9560
|
+
# @!attribute [rw] disk_iops_configuration
|
9561
|
+
# The SSD IOPS (input/output operations per second) configuration for
|
9562
|
+
# an Amazon FSx for Windows file system. By default, Amazon FSx
|
9563
|
+
# automatically provisions 3 IOPS per GiB of storage capacity. You can
|
9564
|
+
# provision additional IOPS per GiB of storage, up to the maximum
|
9565
|
+
# limit associated with your chosen throughput capacity.
|
9566
|
+
# @return [Types::DiskIopsConfiguration]
|
9567
|
+
#
|
8891
9568
|
# @see http://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/WindowsFileSystemConfiguration AWS API Documentation
|
8892
9569
|
#
|
8893
9570
|
class WindowsFileSystemConfiguration < Struct.new(
|
@@ -8904,7 +9581,8 @@ module Aws::FSx
|
|
8904
9581
|
:automatic_backup_retention_days,
|
8905
9582
|
:copy_tags_to_backups,
|
8906
9583
|
:aliases,
|
8907
|
-
:audit_log_configuration
|
9584
|
+
:audit_log_configuration,
|
9585
|
+
:disk_iops_configuration)
|
8908
9586
|
SENSITIVE = []
|
8909
9587
|
include Aws::Structure
|
8910
9588
|
end
|