@aws-sdk/client-efs 3.451.0 → 3.458.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.
- package/README.md +30 -30
- package/dist-cjs/models/models_0.js +15 -1
- package/dist-cjs/pagination/DescribeMountTargetsPaginator.js +29 -0
- package/dist-cjs/pagination/DescribeReplicationConfigurationsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1 -0
- package/dist-es/models/models_0.js +14 -0
- package/dist-es/pagination/DescribeMountTargetsPaginator.js +25 -0
- package/dist-es/pagination/DescribeReplicationConfigurationsPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -0
- package/dist-types/commands/CreateAccessPointCommand.d.ts +8 -7
- package/dist-types/commands/CreateFileSystemCommand.d.ts +11 -6
- package/dist-types/commands/CreateMountTargetCommand.d.ts +6 -6
- package/dist-types/commands/CreateReplicationConfigurationCommand.d.ts +8 -10
- package/dist-types/commands/DescribeAccessPointsCommand.d.ts +5 -3
- package/dist-types/commands/DescribeFileSystemPolicyCommand.d.ts +2 -1
- package/dist-types/commands/DescribeFileSystemsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeLifecycleConfigurationCommand.d.ts +5 -6
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/PutAccountPreferencesCommand.d.ts +4 -5
- package/dist-types/commands/PutFileSystemPolicyCommand.d.ts +8 -8
- package/dist-types/commands/PutLifecycleConfigurationCommand.d.ts +35 -17
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateFileSystemCommand.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +168 -97
- package/dist-types/pagination/DescribeMountTargetsPaginator.d.ts +7 -0
- package/dist-types/pagination/DescribeReplicationConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +18 -0
- package/dist-types/ts3.4/pagination/DescribeMountTargetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/DescribeReplicationConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/package.json +3 -3
|
@@ -109,18 +109,19 @@ export interface CreationInfo {
|
|
|
109
109
|
export interface RootDirectory {
|
|
110
110
|
/**
|
|
111
111
|
* @public
|
|
112
|
-
* <p>Specifies the path on the EFS file system to expose as the root directory to
|
|
113
|
-
*
|
|
114
|
-
*
|
|
112
|
+
* <p>Specifies the path on the EFS file system to expose as the root directory to
|
|
113
|
+
* NFS clients using the access point to access the EFS file system. A path can have
|
|
114
|
+
* up to four subdirectories. If the specified path does not exist, you are required to provide
|
|
115
|
+
* the <code>CreationInfo</code>.</p>
|
|
115
116
|
*/
|
|
116
117
|
Path?: string;
|
|
117
118
|
/**
|
|
118
119
|
* @public
|
|
119
|
-
* <p>(Optional) Specifies the POSIX IDs and permissions to apply to the access point's
|
|
120
|
-
*
|
|
121
|
-
* EFS creates the root directory using the
|
|
122
|
-
*
|
|
123
|
-
*
|
|
120
|
+
* <p>(Optional) Specifies the POSIX IDs and permissions to apply to the access point's
|
|
121
|
+
* <code>RootDirectory</code>. If the <code>RootDirectory</code> > <code>Path</code>
|
|
122
|
+
* specified does not exist, EFS creates the root directory using the
|
|
123
|
+
* <code>CreationInfo</code> settings when a client connects to an access point. When
|
|
124
|
+
* specifying the <code>CreationInfo</code>, you must provide values for all properties. </p>
|
|
124
125
|
* <important>
|
|
125
126
|
* <p>If you do not provide <code>CreationInfo</code> and the specified <code>RootDirectory</code> > <code>Path</code> does not exist,
|
|
126
127
|
* attempts to mount the file system using the access point will fail.</p>
|
|
@@ -188,7 +189,8 @@ export interface AccessPointDescription {
|
|
|
188
189
|
PosixUser?: PosixUser;
|
|
189
190
|
/**
|
|
190
191
|
* @public
|
|
191
|
-
* <p>The directory on the
|
|
192
|
+
* <p>The directory on the EFS file system that the access point exposes as the root
|
|
193
|
+
* directory to NFS clients using the access point.</p>
|
|
192
194
|
*/
|
|
193
195
|
RootDirectory?: RootDirectory;
|
|
194
196
|
/**
|
|
@@ -315,26 +317,29 @@ export interface BackupPolicy {
|
|
|
315
317
|
* <p>
|
|
316
318
|
* <b>
|
|
317
319
|
* <code>ENABLED</code>
|
|
318
|
-
* </b>
|
|
320
|
+
* </b> – EFS is automatically
|
|
321
|
+
* backing up the file system.</p>
|
|
319
322
|
* </li>
|
|
320
323
|
* <li>
|
|
321
324
|
* <p>
|
|
322
325
|
* <b>
|
|
323
326
|
* <code>ENABLING</code>
|
|
324
|
-
* </b>
|
|
327
|
+
* </b> – EFS is turning on
|
|
328
|
+
* automatic backups for the file system.</p>
|
|
325
329
|
* </li>
|
|
326
330
|
* <li>
|
|
327
331
|
* <p>
|
|
328
332
|
* <b>
|
|
329
333
|
* <code>DISABLED</code>
|
|
330
|
-
* </b>
|
|
331
|
-
* the file system.</p>
|
|
334
|
+
* </b> – Automatic back ups are turned
|
|
335
|
+
* off for the file system.</p>
|
|
332
336
|
* </li>
|
|
333
337
|
* <li>
|
|
334
338
|
* <p>
|
|
335
339
|
* <b>
|
|
336
340
|
* <code>DISABLING</code>
|
|
337
|
-
* </b>
|
|
341
|
+
* </b> – EFS is turning off
|
|
342
|
+
* automatic backups for the file system.</p>
|
|
338
343
|
* </li>
|
|
339
344
|
* </ul>
|
|
340
345
|
*/
|
|
@@ -409,13 +414,12 @@ export interface CreateAccessPointRequest {
|
|
|
409
414
|
PosixUser?: PosixUser;
|
|
410
415
|
/**
|
|
411
416
|
* @public
|
|
412
|
-
* <p>Specifies the directory on the
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
* <code>RootDirectory</code> > <code>Path</code> specified does not exist, EFS creates it
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
* <code>CreationInfo</code>.</p>
|
|
417
|
+
* <p>Specifies the directory on the EFS file system that the access point exposes as
|
|
418
|
+
* the root directory of your file system to NFS clients using the access point. The clients
|
|
419
|
+
* using the access point can only access the root directory and below. If the
|
|
420
|
+
* <code>RootDirectory</code> > <code>Path</code> specified does not exist, Amazon EFS creates it and applies the <code>CreationInfo</code> settings when a client connects to an
|
|
421
|
+
* access point. When specifying a <code>RootDirectory</code>, you must provide the
|
|
422
|
+
* <code>Path</code>, and the <code>CreationInfo</code>.</p>
|
|
419
423
|
* <p>Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory.
|
|
420
424
|
* If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount
|
|
421
425
|
* using the access point will fail.</p>
|
|
@@ -570,14 +574,15 @@ export interface CreateFileSystemRequest {
|
|
|
570
574
|
CreationToken?: string;
|
|
571
575
|
/**
|
|
572
576
|
* @public
|
|
573
|
-
* <p>The
|
|
574
|
-
* performance mode for
|
|
577
|
+
* <p>The Performance mode of the file system. We recommend <code>generalPurpose</code>
|
|
578
|
+
* performance mode for all file systems. File systems using the <code>maxIO</code> performance
|
|
575
579
|
* mode can scale to higher levels of aggregate throughput and operations per second with a
|
|
576
580
|
* tradeoff of slightly higher latencies for most file operations. The performance mode
|
|
577
|
-
* can't be changed after the file system has been created
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
+
* can't be changed after the file system has been created. The <code>maxIO</code> mode is
|
|
582
|
+
* not supported on One Zone file systems.</p>
|
|
583
|
+
* <important>
|
|
584
|
+
* <p>Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.</p>
|
|
585
|
+
* </important>
|
|
581
586
|
* <p>Default is <code>generalPurpose</code>.</p>
|
|
582
587
|
*/
|
|
583
588
|
PerformanceMode?: PerformanceMode;
|
|
@@ -627,8 +632,8 @@ export interface CreateFileSystemRequest {
|
|
|
627
632
|
* <code>provisioned</code>, or <code>elastic</code>. If you set <code>ThroughputMode</code> to
|
|
628
633
|
* <code>provisioned</code>, you must also set a value for
|
|
629
634
|
* <code>ProvisionedThroughputInMibps</code>. After you create the file system, you can
|
|
630
|
-
* decrease your file system's
|
|
631
|
-
*
|
|
635
|
+
* decrease your file system's Provisioned throughput or change between the
|
|
636
|
+
* throughput modes, with certain time restrictions. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput">Specifying
|
|
632
637
|
* throughput with provisioned mode</a> in the <i>Amazon EFS User
|
|
633
638
|
* Guide</i>. </p>
|
|
634
639
|
* <p>Default is <code>bursting</code>.</p>
|
|
@@ -646,23 +651,23 @@ export interface CreateFileSystemRequest {
|
|
|
646
651
|
ProvisionedThroughputInMibps?: number;
|
|
647
652
|
/**
|
|
648
653
|
* @public
|
|
649
|
-
* <p>Used to create a
|
|
650
|
-
* Availability Zone in which to create the file system. Use the format <code>us-east-1a</code>
|
|
651
|
-
*
|
|
652
|
-
*
|
|
654
|
+
* <p>Used to create a One Zone file system. It specifies the Amazon Web Services
|
|
655
|
+
* Availability Zone in which to create the file system. Use the format <code>us-east-1a</code> to
|
|
656
|
+
* specify the Availability Zone. For more information about One Zone file systems, see
|
|
657
|
+
* <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">Using EFS storage
|
|
658
|
+
* classes</a> in the <i>Amazon EFS User Guide</i>.</p>
|
|
653
659
|
* <note>
|
|
654
|
-
* <p>One Zone
|
|
655
|
-
* Amazon EFS is available.</p>
|
|
660
|
+
* <p>One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.</p>
|
|
656
661
|
* </note>
|
|
657
662
|
*/
|
|
658
663
|
AvailabilityZoneName?: string;
|
|
659
664
|
/**
|
|
660
665
|
* @public
|
|
661
666
|
* <p>Specifies whether automatic backups are enabled on the file system that you are creating.
|
|
662
|
-
* Set the value to <code>true</code> to enable automatic backups. If you are creating a
|
|
663
|
-
*
|
|
667
|
+
* Set the value to <code>true</code> to enable automatic backups. If you are creating a
|
|
668
|
+
* One Zone file system, automatic backups are enabled by default. For more
|
|
664
669
|
* information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups">Automatic backups</a> in the
|
|
665
|
-
*
|
|
670
|
+
* <i>Amazon EFS User Guide</i>.</p>
|
|
666
671
|
* <p>Default is <code>false</code>. However, if you specify an <code>AvailabilityZoneName</code>,
|
|
667
672
|
* the default is <code>true</code>.</p>
|
|
668
673
|
* <note>
|
|
@@ -733,16 +738,22 @@ export interface FileSystemSize {
|
|
|
733
738
|
Timestamp?: Date;
|
|
734
739
|
/**
|
|
735
740
|
* @public
|
|
736
|
-
* <p>The latest known metered size (in bytes) of data stored in the Infrequent Access
|
|
737
|
-
*
|
|
741
|
+
* <p>The latest known metered size (in bytes) of data stored in the Infrequent Access storage
|
|
742
|
+
* class.</p>
|
|
738
743
|
*/
|
|
739
744
|
ValueInIA?: number;
|
|
740
745
|
/**
|
|
741
746
|
* @public
|
|
742
|
-
* <p>The latest known metered size (in bytes) of data stored in the Standard
|
|
743
|
-
* class.</p>
|
|
747
|
+
* <p>The latest known metered size (in bytes) of data stored in the Standard
|
|
748
|
+
* storage class.</p>
|
|
744
749
|
*/
|
|
745
750
|
ValueInStandard?: number;
|
|
751
|
+
/**
|
|
752
|
+
* @public
|
|
753
|
+
* <p>The latest known metered size (in bytes) of data stored in the Archive
|
|
754
|
+
* storage class.</p>
|
|
755
|
+
*/
|
|
756
|
+
ValueInArchive?: number;
|
|
746
757
|
}
|
|
747
758
|
/**
|
|
748
759
|
* @public
|
|
@@ -767,9 +778,10 @@ export interface FileSystemDescription {
|
|
|
767
778
|
/**
|
|
768
779
|
* @public
|
|
769
780
|
* <p>The Amazon Resource Name (ARN) for the EFS file system, in the format
|
|
770
|
-
*
|
|
781
|
+
* <code>arn:aws:elasticfilesystem:<i>region</i>:<i>account-id</i>:file-system/<i>file-system-id</i>
|
|
771
782
|
* </code>.
|
|
772
|
-
* Example with sample data:
|
|
783
|
+
* Example with sample data:
|
|
784
|
+
* <code>arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567</code>
|
|
773
785
|
* </p>
|
|
774
786
|
*/
|
|
775
787
|
FileSystemArn?: string;
|
|
@@ -811,7 +823,7 @@ export interface FileSystemDescription {
|
|
|
811
823
|
SizeInBytes: FileSystemSize | undefined;
|
|
812
824
|
/**
|
|
813
825
|
* @public
|
|
814
|
-
* <p>The
|
|
826
|
+
* <p>The Performance mode of the file system.</p>
|
|
815
827
|
*/
|
|
816
828
|
PerformanceMode: PerformanceMode | undefined;
|
|
817
829
|
/**
|
|
@@ -840,16 +852,17 @@ export interface FileSystemDescription {
|
|
|
840
852
|
ProvisionedThroughputInMibps?: number;
|
|
841
853
|
/**
|
|
842
854
|
* @public
|
|
843
|
-
* <p>Describes the Amazon Web Services Availability Zone in which the file system is located, and is
|
|
844
|
-
*
|
|
845
|
-
*
|
|
855
|
+
* <p>Describes the Amazon Web Services Availability Zone in which the file system is located, and is
|
|
856
|
+
* valid only for One Zone file systems. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html">Using EFS storage
|
|
857
|
+
* classes</a> in the <i>Amazon EFS User Guide</i>.</p>
|
|
846
858
|
*/
|
|
847
859
|
AvailabilityZoneName?: string;
|
|
848
860
|
/**
|
|
849
861
|
* @public
|
|
850
|
-
* <p>The unique and consistent identifier of the Availability Zone in which the file system
|
|
851
|
-
* One Zone
|
|
852
|
-
*
|
|
862
|
+
* <p>The unique and consistent identifier of the Availability Zone in which the file system is
|
|
863
|
+
* located, and is valid only for One Zone file systems. For example,
|
|
864
|
+
* <code>use1-az1</code> is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and
|
|
865
|
+
* it has the same location in every Amazon Web Services account.</p>
|
|
853
866
|
*/
|
|
854
867
|
AvailabilityZoneId?: string;
|
|
855
868
|
/**
|
|
@@ -985,8 +998,8 @@ export interface CreateMountTargetRequest {
|
|
|
985
998
|
FileSystemId: string | undefined;
|
|
986
999
|
/**
|
|
987
1000
|
* @public
|
|
988
|
-
* <p>The ID of the subnet to add the mount target in. For
|
|
989
|
-
*
|
|
1001
|
+
* <p>The ID of the subnet to add the mount target in. For One Zone file systems, use the
|
|
1002
|
+
* subnet that is associated with the file system's Availability Zone.</p>
|
|
990
1003
|
*/
|
|
991
1004
|
SubnetId: string | undefined;
|
|
992
1005
|
/**
|
|
@@ -1268,13 +1281,12 @@ export declare class SubnetNotFound extends __BaseException {
|
|
|
1268
1281
|
export interface DestinationToCreate {
|
|
1269
1282
|
/**
|
|
1270
1283
|
* @public
|
|
1271
|
-
* <p>To create a file system that uses Regional storage, specify the Amazon Web Services Region
|
|
1272
|
-
* in which to create the destination file system.</p>
|
|
1284
|
+
* <p>To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.</p>
|
|
1273
1285
|
*/
|
|
1274
1286
|
Region?: string;
|
|
1275
1287
|
/**
|
|
1276
1288
|
* @public
|
|
1277
|
-
* <p>To create a file system that uses
|
|
1289
|
+
* <p>To create a file system that uses One Zone storage, specify the name of the
|
|
1278
1290
|
* Availability Zone in which to create the destination file system.</p>
|
|
1279
1291
|
*/
|
|
1280
1292
|
AvailabilityZoneName?: string;
|
|
@@ -1343,7 +1355,7 @@ export type ReplicationStatus = (typeof ReplicationStatus)[keyof typeof Replicat
|
|
|
1343
1355
|
export interface Destination {
|
|
1344
1356
|
/**
|
|
1345
1357
|
* @public
|
|
1346
|
-
* <p>Describes the status of the destination
|
|
1358
|
+
* <p>Describes the status of the destination EFS file system.</p>
|
|
1347
1359
|
* <ul>
|
|
1348
1360
|
* <li>
|
|
1349
1361
|
* <p>The <code>Paused</code> state occurs as a result of opting out of the source or
|
|
@@ -1394,7 +1406,8 @@ export interface ReplicationConfigurationDescription {
|
|
|
1394
1406
|
SourceFileSystemId: string | undefined;
|
|
1395
1407
|
/**
|
|
1396
1408
|
* @public
|
|
1397
|
-
* <p>The Amazon Web Services Region in which the source
|
|
1409
|
+
* <p>The Amazon Web Services Region in which the source EFS file system is
|
|
1410
|
+
* located.</p>
|
|
1398
1411
|
*/
|
|
1399
1412
|
SourceFileSystemRegion: string | undefined;
|
|
1400
1413
|
/**
|
|
@@ -1405,7 +1418,8 @@ export interface ReplicationConfigurationDescription {
|
|
|
1405
1418
|
SourceFileSystemArn: string | undefined;
|
|
1406
1419
|
/**
|
|
1407
1420
|
* @public
|
|
1408
|
-
* <p>The Amazon Resource Name (ARN) of the original source
|
|
1421
|
+
* <p>The Amazon Resource Name (ARN) of the original source EFS file system in the
|
|
1422
|
+
* replication configuration.</p>
|
|
1409
1423
|
*/
|
|
1410
1424
|
OriginalSourceFileSystemArn: string | undefined;
|
|
1411
1425
|
/**
|
|
@@ -1545,7 +1559,8 @@ export declare class FileSystemInUse extends __BaseException {
|
|
|
1545
1559
|
export interface DeleteFileSystemPolicyRequest {
|
|
1546
1560
|
/**
|
|
1547
1561
|
* @public
|
|
1548
|
-
* <p>Specifies the EFS file system for which to delete the
|
|
1562
|
+
* <p>Specifies the EFS file system for which to delete the
|
|
1563
|
+
* <code>FileSystemPolicy</code>.</p>
|
|
1549
1564
|
*/
|
|
1550
1565
|
FileSystemId: string | undefined;
|
|
1551
1566
|
}
|
|
@@ -1662,12 +1677,14 @@ export interface DescribeAccessPointsRequest {
|
|
|
1662
1677
|
NextToken?: string;
|
|
1663
1678
|
/**
|
|
1664
1679
|
* @public
|
|
1665
|
-
* <p>(Optional) Specifies an EFS access point to describe in the response; mutually
|
|
1680
|
+
* <p>(Optional) Specifies an EFS access point to describe in the response; mutually
|
|
1681
|
+
* exclusive with <code>FileSystemId</code>.</p>
|
|
1666
1682
|
*/
|
|
1667
1683
|
AccessPointId?: string;
|
|
1668
1684
|
/**
|
|
1669
1685
|
* @public
|
|
1670
|
-
* <p>(Optional) If you provide a <code>FileSystemId</code>, EFS returns all access
|
|
1686
|
+
* <p>(Optional) If you provide a <code>FileSystemId</code>, EFS returns all access
|
|
1687
|
+
* points for that file system; mutually exclusive with <code>AccessPointId</code>.</p>
|
|
1671
1688
|
*/
|
|
1672
1689
|
FileSystemId?: string;
|
|
1673
1690
|
}
|
|
@@ -1736,7 +1753,8 @@ export type Resource = (typeof Resource)[keyof typeof Resource];
|
|
|
1736
1753
|
export interface ResourceIdPreference {
|
|
1737
1754
|
/**
|
|
1738
1755
|
* @public
|
|
1739
|
-
* <p>Identifies the EFS resource ID preference, either <code>LONG_ID</code> (17
|
|
1756
|
+
* <p>Identifies the EFS resource ID preference, either <code>LONG_ID</code> (17
|
|
1757
|
+
* characters) or <code>SHORT_ID</code> (8 characters).</p>
|
|
1740
1758
|
*/
|
|
1741
1759
|
ResourceIdType?: ResourceIdType;
|
|
1742
1760
|
/**
|
|
@@ -1767,7 +1785,8 @@ export interface DescribeAccountPreferencesResponse {
|
|
|
1767
1785
|
export interface DescribeBackupPolicyRequest {
|
|
1768
1786
|
/**
|
|
1769
1787
|
* @public
|
|
1770
|
-
* <p>Specifies which EFS file system to retrieve the
|
|
1788
|
+
* <p>Specifies which EFS file system for which to retrieve the
|
|
1789
|
+
* <code>BackupPolicy</code>.</p>
|
|
1771
1790
|
*/
|
|
1772
1791
|
FileSystemId: string | undefined;
|
|
1773
1792
|
}
|
|
@@ -1804,7 +1823,8 @@ export declare class PolicyNotFound extends __BaseException {
|
|
|
1804
1823
|
export interface DescribeFileSystemPolicyRequest {
|
|
1805
1824
|
/**
|
|
1806
1825
|
* @public
|
|
1807
|
-
* <p>Specifies which EFS file system to retrieve the <code>FileSystemPolicy</code>
|
|
1826
|
+
* <p>Specifies which EFS file system to retrieve the <code>FileSystemPolicy</code>
|
|
1827
|
+
* for.</p>
|
|
1808
1828
|
*/
|
|
1809
1829
|
FileSystemId: string | undefined;
|
|
1810
1830
|
}
|
|
@@ -1814,12 +1834,14 @@ export interface DescribeFileSystemPolicyRequest {
|
|
|
1814
1834
|
export interface FileSystemPolicyDescription {
|
|
1815
1835
|
/**
|
|
1816
1836
|
* @public
|
|
1817
|
-
* <p>Specifies the EFS file system to which the <code>FileSystemPolicy</code>
|
|
1837
|
+
* <p>Specifies the EFS file system to which the <code>FileSystemPolicy</code>
|
|
1838
|
+
* applies.</p>
|
|
1818
1839
|
*/
|
|
1819
1840
|
FileSystemId?: string;
|
|
1820
1841
|
/**
|
|
1821
1842
|
* @public
|
|
1822
|
-
* <p>The JSON formatted <code>FileSystemPolicy</code> for the EFS file
|
|
1843
|
+
* <p>The JSON formatted <code>FileSystemPolicy</code> for the EFS file
|
|
1844
|
+
* system.</p>
|
|
1823
1845
|
*/
|
|
1824
1846
|
Policy?: string;
|
|
1825
1847
|
}
|
|
@@ -1887,14 +1909,36 @@ export interface DescribeLifecycleConfigurationRequest {
|
|
|
1887
1909
|
*/
|
|
1888
1910
|
FileSystemId: string | undefined;
|
|
1889
1911
|
}
|
|
1912
|
+
/**
|
|
1913
|
+
* @public
|
|
1914
|
+
* @enum
|
|
1915
|
+
*/
|
|
1916
|
+
export declare const TransitionToArchiveRules: {
|
|
1917
|
+
readonly AFTER_14_DAYS: "AFTER_14_DAYS";
|
|
1918
|
+
readonly AFTER_180_DAYS: "AFTER_180_DAYS";
|
|
1919
|
+
readonly AFTER_1_DAY: "AFTER_1_DAY";
|
|
1920
|
+
readonly AFTER_270_DAYS: "AFTER_270_DAYS";
|
|
1921
|
+
readonly AFTER_30_DAYS: "AFTER_30_DAYS";
|
|
1922
|
+
readonly AFTER_365_DAYS: "AFTER_365_DAYS";
|
|
1923
|
+
readonly AFTER_60_DAYS: "AFTER_60_DAYS";
|
|
1924
|
+
readonly AFTER_7_DAYS: "AFTER_7_DAYS";
|
|
1925
|
+
readonly AFTER_90_DAYS: "AFTER_90_DAYS";
|
|
1926
|
+
};
|
|
1927
|
+
/**
|
|
1928
|
+
* @public
|
|
1929
|
+
*/
|
|
1930
|
+
export type TransitionToArchiveRules = (typeof TransitionToArchiveRules)[keyof typeof TransitionToArchiveRules];
|
|
1890
1931
|
/**
|
|
1891
1932
|
* @public
|
|
1892
1933
|
* @enum
|
|
1893
1934
|
*/
|
|
1894
1935
|
export declare const TransitionToIARules: {
|
|
1895
1936
|
readonly AFTER_14_DAYS: "AFTER_14_DAYS";
|
|
1937
|
+
readonly AFTER_180_DAYS: "AFTER_180_DAYS";
|
|
1896
1938
|
readonly AFTER_1_DAY: "AFTER_1_DAY";
|
|
1939
|
+
readonly AFTER_270_DAYS: "AFTER_270_DAYS";
|
|
1897
1940
|
readonly AFTER_30_DAYS: "AFTER_30_DAYS";
|
|
1941
|
+
readonly AFTER_365_DAYS: "AFTER_365_DAYS";
|
|
1898
1942
|
readonly AFTER_60_DAYS: "AFTER_60_DAYS";
|
|
1899
1943
|
readonly AFTER_7_DAYS: "AFTER_7_DAYS";
|
|
1900
1944
|
readonly AFTER_90_DAYS: "AFTER_90_DAYS";
|
|
@@ -1916,36 +1960,42 @@ export declare const TransitionToPrimaryStorageClassRules: {
|
|
|
1916
1960
|
export type TransitionToPrimaryStorageClassRules = (typeof TransitionToPrimaryStorageClassRules)[keyof typeof TransitionToPrimaryStorageClassRules];
|
|
1917
1961
|
/**
|
|
1918
1962
|
* @public
|
|
1919
|
-
* <p>Describes a policy used by
|
|
1920
|
-
*
|
|
1921
|
-
*
|
|
1922
|
-
* Management</a>.</p>
|
|
1963
|
+
* <p>Describes a policy used by Lifecycle management that specifies when to transition files
|
|
1964
|
+
* into and out of the Infrequent Access (IA) and Archive storage
|
|
1965
|
+
* classes. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">Managing file system storage</a>.</p>
|
|
1923
1966
|
* <note>
|
|
1924
1967
|
* <p>When using the <code>put-lifecycle-configuration</code> CLI command or the
|
|
1925
1968
|
* <code>PutLifecycleConfiguration</code> API action, Amazon EFS requires that each
|
|
1926
1969
|
* <code>LifecyclePolicy</code> object have only a single transition. This means that in a
|
|
1927
1970
|
* request body, <code>LifecyclePolicies</code> must be structured as an array of
|
|
1928
|
-
* <code>LifecyclePolicy</code> objects, one object for each transition
|
|
1929
|
-
* <code>TransitionToIA</code>, <code>TransitionToPrimaryStorageClass</code>. For more
|
|
1971
|
+
* <code>LifecyclePolicy</code> objects, one object for each transition. For more
|
|
1930
1972
|
* information, see the request examples in <a>PutLifecycleConfiguration</a>.</p>
|
|
1931
1973
|
* </note>
|
|
1932
1974
|
*/
|
|
1933
1975
|
export interface LifecyclePolicy {
|
|
1934
1976
|
/**
|
|
1935
1977
|
* @public
|
|
1936
|
-
* <p>
|
|
1937
|
-
*
|
|
1938
|
-
* operations such as listing the contents of a directory
|
|
1939
|
-
* events.</p>
|
|
1978
|
+
* <p>The number of days after files were last accessed in primary storage (the
|
|
1979
|
+
* Standard storage class) at which to move them to Infrequent Access
|
|
1980
|
+
* (IA) storage. Metadata operations such as listing the contents of a directory
|
|
1981
|
+
* don't count as file access events.</p>
|
|
1940
1982
|
*/
|
|
1941
1983
|
TransitionToIA?: TransitionToIARules;
|
|
1942
1984
|
/**
|
|
1943
1985
|
* @public
|
|
1944
|
-
* <p>
|
|
1945
|
-
*
|
|
1946
|
-
* events.</p>
|
|
1986
|
+
* <p>Whether to move files back to primary (Standard) storage after they are
|
|
1987
|
+
* accessed in IA or Archive storage. Metadata operations such as
|
|
1988
|
+
* listing the contents of a directory don't count as file access events.</p>
|
|
1947
1989
|
*/
|
|
1948
1990
|
TransitionToPrimaryStorageClass?: TransitionToPrimaryStorageClassRules;
|
|
1991
|
+
/**
|
|
1992
|
+
* @public
|
|
1993
|
+
* <p>The number of days after files were last accessed in primary storage (the
|
|
1994
|
+
* Standard storage class) files at which to move them to Archive
|
|
1995
|
+
* storage. Metadata operations such as listing the contents of a directory don't count as
|
|
1996
|
+
* file access events.</p>
|
|
1997
|
+
*/
|
|
1998
|
+
TransitionToArchive?: TransitionToArchiveRules;
|
|
1949
1999
|
}
|
|
1950
2000
|
/**
|
|
1951
2001
|
* @public
|
|
@@ -2196,7 +2246,8 @@ export declare class InvalidPolicyException extends __BaseException {
|
|
|
2196
2246
|
export interface ListTagsForResourceRequest {
|
|
2197
2247
|
/**
|
|
2198
2248
|
* @public
|
|
2199
|
-
* <p>Specifies the EFS resource you want to retrieve tags for. You can retrieve tags
|
|
2249
|
+
* <p>Specifies the EFS resource you want to retrieve tags for. You can retrieve tags
|
|
2250
|
+
* for EFS file systems and access points using this API endpoint.</p>
|
|
2200
2251
|
*/
|
|
2201
2252
|
ResourceId: string | undefined;
|
|
2202
2253
|
/**
|
|
@@ -2248,9 +2299,8 @@ export interface ModifyMountTargetSecurityGroupsRequest {
|
|
|
2248
2299
|
export interface PutAccountPreferencesRequest {
|
|
2249
2300
|
/**
|
|
2250
2301
|
* @public
|
|
2251
|
-
* <p>Specifies the EFS resource ID preference to set for the user's Amazon Web Services account,
|
|
2252
|
-
*
|
|
2253
|
-
* <code>SHORT_ID</code> (8 characters).</p>
|
|
2302
|
+
* <p>Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, either <code>LONG_ID</code>
|
|
2303
|
+
* (17 characters), or <code>SHORT_ID</code> (8 characters).</p>
|
|
2254
2304
|
* <note>
|
|
2255
2305
|
* <p>Starting in October, 2021, you will receive an error when setting the account preference to
|
|
2256
2306
|
* <code>SHORT_ID</code>. Contact Amazon Web Services support if you receive an error and must
|
|
@@ -2290,16 +2340,15 @@ export interface PutBackupPolicyRequest {
|
|
|
2290
2340
|
export interface PutFileSystemPolicyRequest {
|
|
2291
2341
|
/**
|
|
2292
2342
|
* @public
|
|
2293
|
-
* <p>The ID of the EFS file system that you want to create or update the
|
|
2343
|
+
* <p>The ID of the EFS file system that you want to create or update the
|
|
2344
|
+
* <code>FileSystemPolicy</code> for.</p>
|
|
2294
2345
|
*/
|
|
2295
2346
|
FileSystemId: string | undefined;
|
|
2296
2347
|
/**
|
|
2297
2348
|
* @public
|
|
2298
|
-
* <p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted
|
|
2299
|
-
*
|
|
2300
|
-
*
|
|
2301
|
-
* <a href="https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies">EFS Resource-based Policies</a>.
|
|
2302
|
-
* </p>
|
|
2349
|
+
* <p>The <code>FileSystemPolicy</code> that you're creating. Accepts a JSON formatted
|
|
2350
|
+
* policy definition. EFS file system policies have a 20,000 character limit. To find
|
|
2351
|
+
* out more about the elements that make up a file system policy, see <a href="https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies">EFS Resource-based Policies</a>. </p>
|
|
2303
2352
|
*/
|
|
2304
2353
|
Policy: string | undefined;
|
|
2305
2354
|
/**
|
|
@@ -2327,13 +2376,36 @@ export interface PutLifecycleConfigurationRequest {
|
|
|
2327
2376
|
* @public
|
|
2328
2377
|
* <p>An array of <code>LifecyclePolicy</code> objects that define the file system's
|
|
2329
2378
|
* <code>LifecycleConfiguration</code> object. A <code>LifecycleConfiguration</code> object
|
|
2330
|
-
* informs EFS
|
|
2379
|
+
* informs EFS Lifecycle management of the following:</p>
|
|
2331
2380
|
* <ul>
|
|
2332
2381
|
* <li>
|
|
2333
|
-
* <p>
|
|
2382
|
+
* <p>
|
|
2383
|
+
* <b>
|
|
2384
|
+
* <code>TransitionToIA</code>
|
|
2385
|
+
* </b> –
|
|
2386
|
+
* When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access
|
|
2387
|
+
* (IA) storage.</p>
|
|
2388
|
+
* </li>
|
|
2389
|
+
* <li>
|
|
2390
|
+
* <p>
|
|
2391
|
+
* <b>
|
|
2392
|
+
* <code>TransitionToArchive</code>
|
|
2393
|
+
* </b> –
|
|
2394
|
+
* When to move files in the file system from their current storage class (either IA or Standard storage) into the
|
|
2395
|
+
* Archive storage.</p>
|
|
2396
|
+
* <p>File systems cannot transition into Archive storage before transitioning into IA storage. Therefore,
|
|
2397
|
+
* TransitionToArchive must either not be set or must be later than TransitionToIA.</p>
|
|
2398
|
+
* <note>
|
|
2399
|
+
* <p> The Archive storage class is available only for file systems that use the Elastic Throughput mode
|
|
2400
|
+
* and the General Purpose Performance mode. </p>
|
|
2401
|
+
* </note>
|
|
2334
2402
|
* </li>
|
|
2335
2403
|
* <li>
|
|
2336
|
-
* <p>
|
|
2404
|
+
* <p>
|
|
2405
|
+
* <b>
|
|
2406
|
+
* <code>TransitionToPrimaryStorageClass</code>
|
|
2407
|
+
* </b> – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA
|
|
2408
|
+
* or Archive storage.</p>
|
|
2337
2409
|
* </li>
|
|
2338
2410
|
* </ul>
|
|
2339
2411
|
* <note>
|
|
@@ -2341,8 +2413,7 @@ export interface PutLifecycleConfigurationRequest {
|
|
|
2341
2413
|
* <code>PutLifecycleConfiguration</code> API action, Amazon EFS requires that each
|
|
2342
2414
|
* <code>LifecyclePolicy</code> object have only a single transition. This means that in a
|
|
2343
2415
|
* request body, <code>LifecyclePolicies</code> must be structured as an array of
|
|
2344
|
-
* <code>LifecyclePolicy</code> objects, one object for each transition
|
|
2345
|
-
* <code>TransitionToIA</code>, <code>TransitionToPrimaryStorageClass</code>. See the example
|
|
2416
|
+
* <code>LifecyclePolicy</code> objects, one object for each storage transition. See the example
|
|
2346
2417
|
* requests in the following section for more information.</p>
|
|
2347
2418
|
* </note>
|
|
2348
2419
|
*/
|
|
@@ -2375,8 +2446,8 @@ export interface UntagResourceRequest {
|
|
|
2375
2446
|
ResourceId: string | undefined;
|
|
2376
2447
|
/**
|
|
2377
2448
|
* @public
|
|
2378
|
-
* <p>The keys of the key-value tag pairs that you want to remove from the specified
|
|
2379
|
-
* resource.</p>
|
|
2449
|
+
* <p>The keys of the key-value tag pairs that you want to remove from the specified
|
|
2450
|
+
* EFS resource.</p>
|
|
2380
2451
|
*/
|
|
2381
2452
|
TagKeys: string[] | undefined;
|
|
2382
2453
|
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { DescribeMountTargetsCommandInput, DescribeMountTargetsCommandOutput } from "../commands/DescribeMountTargetsCommand";
|
|
3
|
+
import { EFSPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare function paginateDescribeMountTargets(config: EFSPaginationConfiguration, input: DescribeMountTargetsCommandInput, ...additionalArguments: any): Paginator<DescribeMountTargetsCommandOutput>;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { DescribeReplicationConfigurationsCommandInput, DescribeReplicationConfigurationsCommandOutput } from "../commands/DescribeReplicationConfigurationsCommand";
|
|
3
|
+
import { EFSPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare function paginateDescribeReplicationConfigurations(config: EFSPaginationConfiguration, input: DescribeReplicationConfigurationsCommandInput, ...additionalArguments: any): Paginator<DescribeReplicationConfigurationsCommandOutput>;
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
export * from "./DescribeAccessPointsPaginator";
|
|
2
2
|
export * from "./DescribeFileSystemsPaginator";
|
|
3
|
+
export * from "./DescribeMountTargetsPaginator";
|
|
4
|
+
export * from "./DescribeReplicationConfigurationsPaginator";
|
|
3
5
|
export * from "./DescribeTagsPaginator";
|
|
4
6
|
export * from "./Interfaces";
|
|
5
7
|
export * from "./ListTagsForResourcePaginator";
|
|
@@ -180,6 +180,7 @@ export interface FileSystemSize {
|
|
|
180
180
|
Timestamp?: Date;
|
|
181
181
|
ValueInIA?: number;
|
|
182
182
|
ValueInStandard?: number;
|
|
183
|
+
ValueInArchive?: number;
|
|
183
184
|
}
|
|
184
185
|
export interface FileSystemDescription {
|
|
185
186
|
OwnerId: string | undefined;
|
|
@@ -474,10 +475,26 @@ export interface DescribeFileSystemsResponse {
|
|
|
474
475
|
export interface DescribeLifecycleConfigurationRequest {
|
|
475
476
|
FileSystemId: string | undefined;
|
|
476
477
|
}
|
|
478
|
+
export declare const TransitionToArchiveRules: {
|
|
479
|
+
readonly AFTER_14_DAYS: "AFTER_14_DAYS";
|
|
480
|
+
readonly AFTER_180_DAYS: "AFTER_180_DAYS";
|
|
481
|
+
readonly AFTER_1_DAY: "AFTER_1_DAY";
|
|
482
|
+
readonly AFTER_270_DAYS: "AFTER_270_DAYS";
|
|
483
|
+
readonly AFTER_30_DAYS: "AFTER_30_DAYS";
|
|
484
|
+
readonly AFTER_365_DAYS: "AFTER_365_DAYS";
|
|
485
|
+
readonly AFTER_60_DAYS: "AFTER_60_DAYS";
|
|
486
|
+
readonly AFTER_7_DAYS: "AFTER_7_DAYS";
|
|
487
|
+
readonly AFTER_90_DAYS: "AFTER_90_DAYS";
|
|
488
|
+
};
|
|
489
|
+
export type TransitionToArchiveRules =
|
|
490
|
+
(typeof TransitionToArchiveRules)[keyof typeof TransitionToArchiveRules];
|
|
477
491
|
export declare const TransitionToIARules: {
|
|
478
492
|
readonly AFTER_14_DAYS: "AFTER_14_DAYS";
|
|
493
|
+
readonly AFTER_180_DAYS: "AFTER_180_DAYS";
|
|
479
494
|
readonly AFTER_1_DAY: "AFTER_1_DAY";
|
|
495
|
+
readonly AFTER_270_DAYS: "AFTER_270_DAYS";
|
|
480
496
|
readonly AFTER_30_DAYS: "AFTER_30_DAYS";
|
|
497
|
+
readonly AFTER_365_DAYS: "AFTER_365_DAYS";
|
|
481
498
|
readonly AFTER_60_DAYS: "AFTER_60_DAYS";
|
|
482
499
|
readonly AFTER_7_DAYS: "AFTER_7_DAYS";
|
|
483
500
|
readonly AFTER_90_DAYS: "AFTER_90_DAYS";
|
|
@@ -492,6 +509,7 @@ export type TransitionToPrimaryStorageClassRules =
|
|
|
492
509
|
export interface LifecyclePolicy {
|
|
493
510
|
TransitionToIA?: TransitionToIARules;
|
|
494
511
|
TransitionToPrimaryStorageClass?: TransitionToPrimaryStorageClassRules;
|
|
512
|
+
TransitionToArchive?: TransitionToArchiveRules;
|
|
495
513
|
}
|
|
496
514
|
export interface LifecycleConfigurationDescription {
|
|
497
515
|
LifecyclePolicies?: LifecyclePolicy[];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import {
|
|
3
|
+
DescribeMountTargetsCommandInput,
|
|
4
|
+
DescribeMountTargetsCommandOutput,
|
|
5
|
+
} from "../commands/DescribeMountTargetsCommand";
|
|
6
|
+
import { EFSPaginationConfiguration } from "./Interfaces";
|
|
7
|
+
export declare function paginateDescribeMountTargets(
|
|
8
|
+
config: EFSPaginationConfiguration,
|
|
9
|
+
input: DescribeMountTargetsCommandInput,
|
|
10
|
+
...additionalArguments: any
|
|
11
|
+
): Paginator<DescribeMountTargetsCommandOutput>;
|