@aws-sdk/client-efs
Advanced tools
Comparing version 3.67.0 to 3.69.0
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.DeleteMountTargetRequest = exports.DeleteFileSystemPolicyRequest = exports.FileSystemInUse = exports.DeleteFileSystemRequest = exports.DeleteAccessPointRequest = exports.CreateTagsRequest = exports.ValidationException = exports.ReplicationNotFound = exports.ReplicationConfigurationDescription = exports.Destination = exports.ReplicationStatus = exports.CreateReplicationConfigurationRequest = exports.DestinationToCreate = exports.SubnetNotFound = exports.SecurityGroupNotFound = exports.SecurityGroupLimitExceeded = exports.NoFreeAddressesInSubnet = exports.NetworkInterfaceLimitExceeded = exports.MountTargetDescription = exports.MountTargetConflict = exports.IpAddressInUse = exports.CreateMountTargetRequest = exports.UnsupportedAvailabilityZone = exports.ThroughputLimitExceeded = exports.InsufficientThroughputCapacity = exports.FileSystemLimitExceeded = exports.FileSystemDescription = exports.FileSystemSize = exports.FileSystemAlreadyExists = exports.CreateFileSystemRequest = exports.ThroughputMode = exports.PerformanceMode = exports.InternalServerError = exports.IncorrectFileSystemLifeCycleState = exports.FileSystemNotFound = exports.CreateAccessPointRequest = exports.BadRequest = exports.BackupPolicyDescription = exports.BackupPolicy = exports.Status = exports.AvailabilityZonesMismatch = exports.AccessPointNotFound = exports.AccessPointLimitExceeded = exports.AccessPointDescription = exports.Tag = exports.RootDirectory = exports.CreationInfo = exports.PosixUser = exports.LifeCycleState = exports.AccessPointAlreadyExists = void 0; | ||
exports.UpdateFileSystemRequest = exports.TooManyRequests = exports.UntagResourceRequest = exports.TagResourceRequest = exports.PutLifecycleConfigurationRequest = exports.PutFileSystemPolicyRequest = exports.PutBackupPolicyRequest = exports.PutAccountPreferencesResponse = exports.PutAccountPreferencesRequest = exports.ModifyMountTargetSecurityGroupsRequest = exports.ListTagsForResourceResponse = exports.ListTagsForResourceRequest = exports.InvalidPolicyException = exports.DescribeTagsResponse = exports.DescribeTagsRequest = exports.DescribeReplicationConfigurationsResponse = exports.DescribeReplicationConfigurationsRequest = exports.IncorrectMountTargetState = exports.DescribeMountTargetSecurityGroupsResponse = exports.DescribeMountTargetSecurityGroupsRequest = exports.DescribeMountTargetsResponse = exports.DescribeMountTargetsRequest = exports.LifecycleConfigurationDescription = exports.LifecyclePolicy = exports.TransitionToPrimaryStorageClassRules = exports.TransitionToIARules = exports.DescribeLifecycleConfigurationRequest = exports.DescribeFileSystemsResponse = exports.DescribeFileSystemsRequest = exports.FileSystemPolicyDescription = exports.DescribeFileSystemPolicyRequest = exports.PolicyNotFound = exports.DescribeBackupPolicyRequest = exports.DescribeAccountPreferencesResponse = exports.ResourceIdPreference = exports.Resource = exports.ResourceIdType = exports.DescribeAccountPreferencesRequest = exports.DescribeAccessPointsResponse = exports.DescribeAccessPointsRequest = exports.DeleteTagsRequest = exports.DeleteReplicationConfigurationRequest = exports.MountTargetNotFound = exports.DependencyTimeout = void 0; | ||
exports.DeleteFileSystemPolicyRequest = exports.FileSystemInUse = exports.DeleteFileSystemRequest = exports.DeleteAccessPointRequest = exports.CreateTagsRequest = exports.ValidationException = exports.ReplicationNotFound = exports.ReplicationConfigurationDescription = exports.Destination = exports.ReplicationStatus = exports.CreateReplicationConfigurationRequest = exports.DestinationToCreate = exports.SubnetNotFound = exports.SecurityGroupNotFound = exports.SecurityGroupLimitExceeded = exports.NoFreeAddressesInSubnet = exports.NetworkInterfaceLimitExceeded = exports.MountTargetDescription = exports.MountTargetConflict = exports.IpAddressInUse = exports.CreateMountTargetRequest = exports.UnsupportedAvailabilityZone = exports.ThroughputLimitExceeded = exports.InsufficientThroughputCapacity = exports.FileSystemLimitExceeded = exports.FileSystemDescription = exports.FileSystemSize = exports.FileSystemAlreadyExists = exports.CreateFileSystemRequest = exports.ThroughputMode = exports.PerformanceMode = exports.ThrottlingException = exports.InternalServerError = exports.IncorrectFileSystemLifeCycleState = exports.FileSystemNotFound = exports.CreateAccessPointRequest = exports.BadRequest = exports.BackupPolicyDescription = exports.BackupPolicy = exports.Status = exports.AvailabilityZonesMismatch = exports.AccessPointNotFound = exports.AccessPointLimitExceeded = exports.AccessPointDescription = exports.Tag = exports.RootDirectory = exports.CreationInfo = exports.PosixUser = exports.LifeCycleState = exports.AccessPointAlreadyExists = void 0; | ||
exports.UpdateFileSystemRequest = exports.TooManyRequests = exports.UntagResourceRequest = exports.TagResourceRequest = exports.PutLifecycleConfigurationRequest = exports.PutFileSystemPolicyRequest = exports.PutBackupPolicyRequest = exports.PutAccountPreferencesResponse = exports.PutAccountPreferencesRequest = exports.ModifyMountTargetSecurityGroupsRequest = exports.ListTagsForResourceResponse = exports.ListTagsForResourceRequest = exports.InvalidPolicyException = exports.DescribeTagsResponse = exports.DescribeTagsRequest = exports.DescribeReplicationConfigurationsResponse = exports.DescribeReplicationConfigurationsRequest = exports.IncorrectMountTargetState = exports.DescribeMountTargetSecurityGroupsResponse = exports.DescribeMountTargetSecurityGroupsRequest = exports.DescribeMountTargetsResponse = exports.DescribeMountTargetsRequest = exports.LifecycleConfigurationDescription = exports.LifecyclePolicy = exports.TransitionToPrimaryStorageClassRules = exports.TransitionToIARules = exports.DescribeLifecycleConfigurationRequest = exports.DescribeFileSystemsResponse = exports.DescribeFileSystemsRequest = exports.FileSystemPolicyDescription = exports.DescribeFileSystemPolicyRequest = exports.PolicyNotFound = exports.DescribeBackupPolicyRequest = exports.DescribeAccountPreferencesResponse = exports.ResourceIdPreference = exports.Resource = exports.ResourceIdType = exports.DescribeAccountPreferencesRequest = exports.DescribeAccessPointsResponse = exports.DescribeAccessPointsRequest = exports.DeleteTagsRequest = exports.DeleteReplicationConfigurationRequest = exports.MountTargetNotFound = exports.DependencyTimeout = exports.DeleteMountTargetRequest = void 0; | ||
const EFSServiceException_1 = require("./EFSServiceException"); | ||
@@ -191,2 +191,17 @@ class AccessPointAlreadyExists extends EFSServiceException_1.EFSServiceException { | ||
exports.InternalServerError = InternalServerError; | ||
class ThrottlingException extends EFSServiceException_1.EFSServiceException { | ||
constructor(opts) { | ||
super({ | ||
name: "ThrottlingException", | ||
$fault: "client", | ||
...opts, | ||
}); | ||
this.name = "ThrottlingException"; | ||
this.$fault = "client"; | ||
Object.setPrototypeOf(this, ThrottlingException.prototype); | ||
this.ErrorCode = opts.ErrorCode; | ||
this.Message = opts.Message; | ||
} | ||
} | ||
exports.ThrottlingException = ThrottlingException; | ||
var PerformanceMode; | ||
@@ -193,0 +208,0 @@ (function (PerformanceMode) { |
@@ -164,2 +164,16 @@ import { __assign, __extends } from "tslib"; | ||
export { InternalServerError }; | ||
var ThrottlingException = (function (_super) { | ||
__extends(ThrottlingException, _super); | ||
function ThrottlingException(opts) { | ||
var _this = _super.call(this, __assign({ name: "ThrottlingException", $fault: "client" }, opts)) || this; | ||
_this.name = "ThrottlingException"; | ||
_this.$fault = "client"; | ||
Object.setPrototypeOf(_this, ThrottlingException.prototype); | ||
_this.ErrorCode = opts.ErrorCode; | ||
_this.Message = opts.Message; | ||
return _this; | ||
} | ||
return ThrottlingException; | ||
}(__BaseException)); | ||
export { ThrottlingException }; | ||
export var PerformanceMode; | ||
@@ -166,0 +180,0 @@ (function (PerformanceMode) { |
@@ -14,4 +14,4 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
* override any identity information provided by the NFS client. The file system path is exposed | ||
* as the access point's root directory. Applications using the access point can only access data | ||
* in its own directory and below. To learn more, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">Mounting a file system using EFS access | ||
* as the access point's root directory. Applications using the access point can only access data in | ||
* the application's own directory and any subdirectories. To learn more, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">Mounting a file system using EFS access | ||
* points</a>.</p> | ||
@@ -18,0 +18,0 @@ * <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p> |
@@ -10,40 +10,46 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
/** | ||
* <p>Creates a replication configuration that replicates an existing EFS file | ||
* system to a new, read-only file system. For more information, see | ||
* <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a>. | ||
* The replication configuration specifies the following:</p> | ||
* <p>Creates a replication configuration that replicates an existing EFS file system to a new, | ||
* read-only file system. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the | ||
* <i>Amazon EFS User Guide</i>. The replication configuration | ||
* specifies the following:</p> | ||
* <ul> | ||
* <li> | ||
* <p> | ||
* <b>Source file system</b> - an existing | ||
* EFS file system that you want replicated. The source file system cannot be a destination file system | ||
* in an existing replication configuration.</p> | ||
* <b>Source file system</b> - An existing EFS file system that you | ||
* want replicated. The source file system cannot be a destination file system in an existing | ||
* replication configuration.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Destination file system configuration</b> | ||
* - the configuration of the destination file system to which the source file system | ||
* will be replicated. There can only be one destination file system in a replication | ||
* configuration.</p> | ||
* <b>Destination file system configuration</b> - The configuration of | ||
* the destination file system to which the source file system will be replicated. There can | ||
* only be one destination file system in a replication configuration. The destination file | ||
* system configuration consists of the following properties:</p> | ||
* <ul> | ||
* <li> | ||
* <p> | ||
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in which the destination | ||
* file system is created. EFS Replication is available in all Amazon Web Services Region that Amazon EFS is available in, except the following regions: | ||
* Asia Pacific (Hong Kong) Europe (Milan), Middle East (Bahrain), Africa (Cape Town), and Asia Pacific (Jakarta).</p> | ||
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in | ||
* which the destination file system is created. Amazon EFS replication is | ||
* available in all Amazon Web Services Regions that Amazon EFS is available in, | ||
* except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe | ||
* (Milan), and Middle East (Bahrain).</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Availability zone</b> - If you want the destination file system to use | ||
* One Zone availability and durability, you must specify the Availability Zone to create the file system in. | ||
* For more information about EFS storage classes, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html"> | ||
* Amazon EFS storage classes</a> in the <i>Amazon EFS User Guide</i>.</p> | ||
* <b>Availability Zone</b> - If you want the destination file system | ||
* to use EFS One Zone availability and durability, you must specify the Availability | ||
* Zone to create the file system in. For more information about EFS storage classes, see | ||
* <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html"> | ||
* Amazon EFS storage classes</a> in the <i>Amazon EFS User | ||
* Guide</i>.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Encryption</b> - All destination file systems are | ||
* created with encryption at rest enabled. You can specify the | ||
* KMS key that is used to encrypt the destination file system. | ||
* Your service-managed KMS key for Amazon EFS is used if you don't specify a KMS key. | ||
* You cannot change this after the file system is created.</p> | ||
* <b>Encryption</b> - All destination file systems are created with | ||
* encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't | ||
* specify a KMS key, your service-managed KMS key for | ||
* Amazon EFS is used. </p> | ||
* <note> | ||
* <p>After the file system is created, you cannot change the KMS key.</p> | ||
* </note> | ||
* </li> | ||
@@ -58,12 +64,12 @@ * </ul> | ||
* <p> | ||
* <b>Performance mode</b> - The destination file system's | ||
* performance mode will match that of the source file system, unless the destination file | ||
* system uses One Zone storage. In that case, the <i>General Purpose</i> | ||
* performance mode is used. The Performance mode cannot be changed.</p> | ||
* <b>Performance mode</b> - The destination file system's performance | ||
* mode matches that of the source file system, unless the destination file system uses EFS | ||
* One Zone storage. In that case, the General Purpose performance mode is used. The | ||
* performance mode cannot be changed.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Throughput mode</b> - The destination file system | ||
* use the Bursting throughput mode by default. You can modify the throughput mode once the file system | ||
* is created.</p> | ||
* <b>Throughput mode</b> - The destination file system uses the | ||
* Bursting Throughput mode by default. After the file system is created, you can modify the | ||
* throughput mode.</p> | ||
* </li> | ||
@@ -76,14 +82,17 @@ * </ul> | ||
* <p> | ||
* <b>Lifecycle management</b> - EFS lifecycle | ||
* management and intelligent tiering are not enabled on the destination file system. You can enable | ||
* EFS lifecycle management and intelligent tiering after the destination file system is created.</p> | ||
* <b>Lifecycle management</b> - EFS lifecycle management and EFS | ||
* Intelligent-Tiering are not enabled on the destination file system. After the destination | ||
* file system is created, you can enable EFS lifecycle management and EFS | ||
* Intelligent-Tiering.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Automatic backups</b> - Automatic daily backups | ||
* not enabled on the destination file system. You can change this setting after the file system is created.</p> | ||
* <b>Automatic backups</b> - Automatic daily backups not enabled on | ||
* the destination file system. After the file system is created, you can change this | ||
* setting.</p> | ||
* </li> | ||
* </ul> | ||
* | ||
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a>.</p> | ||
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the | ||
* <i>Amazon EFS User Guide</i>.</p> | ||
* @example | ||
@@ -90,0 +99,0 @@ * Use a bare-bones client and the command you need to make an API call. |
@@ -13,4 +13,4 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
* <note> | ||
* <p>DEPRECATED - CreateTags is deprecated and not maintained. Please use the | ||
* API action to create tags for EFS resources.</p> | ||
* <p>DEPRECATED - <code>CreateTags</code> is deprecated and not maintained. To create tags for EFS | ||
* resources, use the API action.</p> | ||
* </note> | ||
@@ -17,0 +17,0 @@ * <p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If |
@@ -13,2 +13,9 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
* system.</p> | ||
* <p>You need to manually delete mount targets attached to a file system before you can delete | ||
* an EFS file system. This step is performed for you when you use the Amazon Web Services console | ||
* to delete a file system.</p> | ||
* <note> | ||
* <p>You cannot delete a file system that is part of an EFS Replication configuration. | ||
* You need to delete the replication configuration first.</p> | ||
* </note> | ||
* <p> You can't delete a file system that is in use. That is, if the file system has | ||
@@ -15,0 +22,0 @@ * any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p> |
@@ -10,7 +10,8 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
/** | ||
* <p>Deletes an existing replication configuration. To delete a replication | ||
* configuration, you must make the request from the Amazon Web Services Region | ||
* in which the destination file system is located. Deleting a replication | ||
* configuration ends the replication process. You can write to the destination file | ||
* system once it's status becomes <code>Writeable</code>.</p> | ||
* <p>Deletes an existing replication configuration. To delete a replication configuration, you | ||
* must make the request from the Amazon Web Services Region in which the destination file system | ||
* is located. Deleting a replication configuration ends the replication process. After a | ||
* replication configuration is deleted, the destination file system is no longer read-only. You | ||
* can write to the destination file system after its status becomes | ||
* <code>Writeable</code>.</p> | ||
* @example | ||
@@ -17,0 +18,0 @@ * Use a bare-bones client and the command you need to make an API call. |
@@ -13,4 +13,4 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
* <note> | ||
* <p>DEPRECATED - DeleteTags is deprecated and not maintained. Please use the | ||
* API action to remove tags from EFS resources.</p> | ||
* <p>DEPRECATED - <code>DeleteTags</code> is deprecated and not maintained. To remove tags from EFS | ||
* resources, use the API action.</p> | ||
* </note> | ||
@@ -17,0 +17,0 @@ * <p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request |
@@ -15,3 +15,4 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
* response.</p> | ||
* <p>When EFS Intelligent Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has a value of <code>AFTER_1_ACCESS</code>.</p> | ||
* <p>When EFS Intelligent-Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has | ||
* a value of <code>AFTER_1_ACCESS</code>.</p> | ||
* <p>This operation requires permissions for the | ||
@@ -18,0 +19,0 @@ * <code>elasticfilesystem:DescribeLifecycleConfiguration</code> operation.</p> |
@@ -10,4 +10,5 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
/** | ||
* <p>Retrieves the replication configurations for either a specific file system, or all configurations for the | ||
* Amazon Web Services account in an Amazon Web Services Region if a file system is not specified.</p> | ||
* <p>Retrieves the replication configuration for a specific file system. If a file system is | ||
* not specified, all of the replication configurations for the Amazon Web Services account in an | ||
* Amazon Web Services Region are retrieved.</p> | ||
* @example | ||
@@ -14,0 +15,0 @@ * Use a bare-bones client and the command you need to make an API call. |
@@ -13,4 +13,5 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
* <note> | ||
* <p>DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the | ||
* API action to remove tags from EFS resources.</p> | ||
* <p>DEPRECATED - The <code>DescribeTags</code> action is deprecated and not maintained. To view | ||
* tags associated with EFS resources, use the <code>ListTagsForResource</code> API | ||
* action.</p> | ||
* </note> | ||
@@ -17,0 +18,0 @@ * <p>Returns the tags associated with a file system. The order of tags returned in the |
@@ -17,4 +17,5 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
* <note> | ||
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. | ||
* Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.</p> | ||
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference | ||
* to use the short 8 character format resource ID. Contact Amazon Web Services support if you | ||
* receive an error and must use short IDs for file system and mount target resources.</p> | ||
* </note> | ||
@@ -21,0 +22,0 @@ * @example |
@@ -10,8 +10,21 @@ import { Command as $Command } from "@aws-sdk/smithy-client"; | ||
/** | ||
* <p>Enables lifecycle management by creating a new <code>LifecycleConfiguration</code> | ||
* object. A <code>LifecycleConfiguration</code> object defines when files in an Amazon EFS file | ||
* system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. | ||
* To enable EFS Intelligent Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>. | ||
* For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>.</p> | ||
* <p>Use this action to manage EFS lifecycle management and intelligent tiering. A | ||
* <code>LifecycleConfiguration</code> consists of one or more <code>LifecyclePolicy</code> objects that | ||
* define the following:</p> | ||
* <ul> | ||
* <li> | ||
* <p> | ||
* <b>EFS Lifecycle management</b> - When Amazon EFS | ||
* automatically transitions files in a file system into the lower-cost Infrequent Access (IA) storage class.</p> | ||
* <p>To enable EFS Lifecycle management, set the value of <code>TransitionToIA</code> to one of the available options.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>EFS Intelligent tiering</b> - When Amazon EFS | ||
* automatically transitions files from IA back into the file system's primary storage class (Standard or One Zone Standard.</p> | ||
* <p>To enable EFS Intelligent Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>.</p> | ||
* </li> | ||
* </ul> | ||
* | ||
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>.</p> | ||
* <p>Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a | ||
@@ -22,23 +35,23 @@ * <code>LifecycleConfiguration</code> object already exists for the specified file system, a | ||
* array in the request body deletes any existing <code>LifecycleConfiguration</code> and | ||
* turns off lifecycle management for the file system.</p> | ||
* | ||
* | ||
* turns off lifecycle management and intelligent tiering for the file system.</p> | ||
* <p>In the request, specify the following: </p> | ||
* <ul> | ||
* <li> | ||
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.</p> | ||
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management | ||
* and intelligent tiering.</p> | ||
* </li> | ||
* <li> | ||
* <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that | ||
* define when files are moved to the IA storage class. Amazon EFS requires that each <code>LifecyclePolicy</code> | ||
* define when files are moved into IA storage, and when they are moved back to Standard storage.</p> | ||
* <note> | ||
* <p>Amazon EFS requires that each <code>LifecyclePolicy</code> | ||
* object have only have a single transition, so the <code>LifecyclePolicies</code> array needs to be structured with separate | ||
* <code>LifecyclePolicy</code> objects. See the example requests in the following section for more information.</p> | ||
* </note> | ||
* </li> | ||
* </ul> | ||
* | ||
* <p>This operation requires permissions for the | ||
* <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p> | ||
* <p>This operation requires permissions for the <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p> | ||
* <p>To apply a <code>LifecycleConfiguration</code> object to an encrypted file system, you | ||
* need the same Key Management Service permissions as when you created the encrypted | ||
* file system. </p> | ||
* need the same Key Management Service permissions as when you created the encrypted file system.</p> | ||
* @example | ||
@@ -45,0 +58,0 @@ * Use a bare-bones client and the command you need to make an API call. |
@@ -35,6 +35,6 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; | ||
* <fullname>Amazon Elastic File System</fullname> | ||
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use | ||
* with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, | ||
* growing and shrinking automatically as you add and remove files, so your applications have the | ||
* storage they need, when they need it. For more information, see the <a href="https://docs.aws.amazon.com/efs/latest/ug/api-reference.html">Amazon Elastic File System API Reference</a> and the <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">Amazon Elastic File System User Guide</a>.</p> | ||
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for | ||
* use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and | ||
* remove files, so that your applications have the storage they need, when they need it. For | ||
* more information, see the <a href="https://docs.aws.amazon.com/efs/latest/ug/api-reference.html">Amazon Elastic File System API Reference</a> and the <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">Amazon Elastic File System User Guide</a>.</p> | ||
*/ | ||
@@ -47,4 +47,4 @@ export declare class EFS extends EFSClient { | ||
* override any identity information provided by the NFS client. The file system path is exposed | ||
* as the access point's root directory. Applications using the access point can only access data | ||
* in its own directory and below. To learn more, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">Mounting a file system using EFS access | ||
* as the access point's root directory. Applications using the access point can only access data in | ||
* the application's own directory and any subdirectories. To learn more, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html">Mounting a file system using EFS access | ||
* points</a>.</p> | ||
@@ -263,40 +263,46 @@ * <p>This operation requires permissions for the <code>elasticfilesystem:CreateAccessPoint</code> action.</p> | ||
/** | ||
* <p>Creates a replication configuration that replicates an existing EFS file | ||
* system to a new, read-only file system. For more information, see | ||
* <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a>. | ||
* The replication configuration specifies the following:</p> | ||
* <p>Creates a replication configuration that replicates an existing EFS file system to a new, | ||
* read-only file system. For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the | ||
* <i>Amazon EFS User Guide</i>. The replication configuration | ||
* specifies the following:</p> | ||
* <ul> | ||
* <li> | ||
* <p> | ||
* <b>Source file system</b> - an existing | ||
* EFS file system that you want replicated. The source file system cannot be a destination file system | ||
* in an existing replication configuration.</p> | ||
* <b>Source file system</b> - An existing EFS file system that you | ||
* want replicated. The source file system cannot be a destination file system in an existing | ||
* replication configuration.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Destination file system configuration</b> | ||
* - the configuration of the destination file system to which the source file system | ||
* will be replicated. There can only be one destination file system in a replication | ||
* configuration.</p> | ||
* <b>Destination file system configuration</b> - The configuration of | ||
* the destination file system to which the source file system will be replicated. There can | ||
* only be one destination file system in a replication configuration. The destination file | ||
* system configuration consists of the following properties:</p> | ||
* <ul> | ||
* <li> | ||
* <p> | ||
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in which the destination | ||
* file system is created. EFS Replication is available in all Amazon Web Services Region that Amazon EFS is available in, except the following regions: | ||
* Asia Pacific (Hong Kong) Europe (Milan), Middle East (Bahrain), Africa (Cape Town), and Asia Pacific (Jakarta).</p> | ||
* <b>Amazon Web Services Region</b> - The Amazon Web Services Region in | ||
* which the destination file system is created. Amazon EFS replication is | ||
* available in all Amazon Web Services Regions that Amazon EFS is available in, | ||
* except Africa (Cape Town), Asia Pacific (Hong Kong), Asia Pacific (Jakarta), Europe | ||
* (Milan), and Middle East (Bahrain).</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Availability zone</b> - If you want the destination file system to use | ||
* One Zone availability and durability, you must specify the Availability Zone to create the file system in. | ||
* For more information about EFS storage classes, see <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html"> | ||
* Amazon EFS storage classes</a> in the <i>Amazon EFS User Guide</i>.</p> | ||
* <b>Availability Zone</b> - If you want the destination file system | ||
* to use EFS One Zone availability and durability, you must specify the Availability | ||
* Zone to create the file system in. For more information about EFS storage classes, see | ||
* <a href="https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html"> | ||
* Amazon EFS storage classes</a> in the <i>Amazon EFS User | ||
* Guide</i>.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Encryption</b> - All destination file systems are | ||
* created with encryption at rest enabled. You can specify the | ||
* KMS key that is used to encrypt the destination file system. | ||
* Your service-managed KMS key for Amazon EFS is used if you don't specify a KMS key. | ||
* You cannot change this after the file system is created.</p> | ||
* <b>Encryption</b> - All destination file systems are created with | ||
* encryption at rest enabled. You can specify the Key Management Service (KMS) key that is used to encrypt the destination file system. If you don't | ||
* specify a KMS key, your service-managed KMS key for | ||
* Amazon EFS is used. </p> | ||
* <note> | ||
* <p>After the file system is created, you cannot change the KMS key.</p> | ||
* </note> | ||
* </li> | ||
@@ -311,12 +317,12 @@ * </ul> | ||
* <p> | ||
* <b>Performance mode</b> - The destination file system's | ||
* performance mode will match that of the source file system, unless the destination file | ||
* system uses One Zone storage. In that case, the <i>General Purpose</i> | ||
* performance mode is used. The Performance mode cannot be changed.</p> | ||
* <b>Performance mode</b> - The destination file system's performance | ||
* mode matches that of the source file system, unless the destination file system uses EFS | ||
* One Zone storage. In that case, the General Purpose performance mode is used. The | ||
* performance mode cannot be changed.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Throughput mode</b> - The destination file system | ||
* use the Bursting throughput mode by default. You can modify the throughput mode once the file system | ||
* is created.</p> | ||
* <b>Throughput mode</b> - The destination file system uses the | ||
* Bursting Throughput mode by default. After the file system is created, you can modify the | ||
* throughput mode.</p> | ||
* </li> | ||
@@ -329,14 +335,17 @@ * </ul> | ||
* <p> | ||
* <b>Lifecycle management</b> - EFS lifecycle | ||
* management and intelligent tiering are not enabled on the destination file system. You can enable | ||
* EFS lifecycle management and intelligent tiering after the destination file system is created.</p> | ||
* <b>Lifecycle management</b> - EFS lifecycle management and EFS | ||
* Intelligent-Tiering are not enabled on the destination file system. After the destination | ||
* file system is created, you can enable EFS lifecycle management and EFS | ||
* Intelligent-Tiering.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>Automatic backups</b> - Automatic daily backups | ||
* not enabled on the destination file system. You can change this setting after the file system is created.</p> | ||
* <b>Automatic backups</b> - Automatic daily backups not enabled on | ||
* the destination file system. After the file system is created, you can change this | ||
* setting.</p> | ||
* </li> | ||
* </ul> | ||
* | ||
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a>.</p> | ||
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html">Amazon EFS replication</a> in the | ||
* <i>Amazon EFS User Guide</i>.</p> | ||
*/ | ||
@@ -350,4 +359,4 @@ createReplicationConfiguration(args: CreateReplicationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateReplicationConfigurationCommandOutput>; | ||
* <note> | ||
* <p>DEPRECATED - CreateTags is deprecated and not maintained. Please use the | ||
* API action to create tags for EFS resources.</p> | ||
* <p>DEPRECATED - <code>CreateTags</code> is deprecated and not maintained. To create tags for EFS | ||
* resources, use the API action.</p> | ||
* </note> | ||
@@ -377,2 +386,9 @@ * <p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If | ||
* system.</p> | ||
* <p>You need to manually delete mount targets attached to a file system before you can delete | ||
* an EFS file system. This step is performed for you when you use the Amazon Web Services console | ||
* to delete a file system.</p> | ||
* <note> | ||
* <p>You cannot delete a file system that is part of an EFS Replication configuration. | ||
* You need to delete the replication configuration first.</p> | ||
* </note> | ||
* <p> You can't delete a file system that is in use. That is, if the file system has | ||
@@ -443,7 +459,8 @@ * any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p> | ||
/** | ||
* <p>Deletes an existing replication configuration. To delete a replication | ||
* configuration, you must make the request from the Amazon Web Services Region | ||
* in which the destination file system is located. Deleting a replication | ||
* configuration ends the replication process. You can write to the destination file | ||
* system once it's status becomes <code>Writeable</code>.</p> | ||
* <p>Deletes an existing replication configuration. To delete a replication configuration, you | ||
* must make the request from the Amazon Web Services Region in which the destination file system | ||
* is located. Deleting a replication configuration ends the replication process. After a | ||
* replication configuration is deleted, the destination file system is no longer read-only. You | ||
* can write to the destination file system after its status becomes | ||
* <code>Writeable</code>.</p> | ||
*/ | ||
@@ -457,4 +474,4 @@ deleteReplicationConfiguration(args: DeleteReplicationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteReplicationConfigurationCommandOutput>; | ||
* <note> | ||
* <p>DEPRECATED - DeleteTags is deprecated and not maintained. Please use the | ||
* API action to remove tags from EFS resources.</p> | ||
* <p>DEPRECATED - <code>DeleteTags</code> is deprecated and not maintained. To remove tags from EFS | ||
* resources, use the API action.</p> | ||
* </note> | ||
@@ -535,3 +552,4 @@ * <p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request | ||
* response.</p> | ||
* <p>When EFS Intelligent Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has a value of <code>AFTER_1_ACCESS</code>.</p> | ||
* <p>When EFS Intelligent-Tiering is enabled, <code>TransitionToPrimaryStorageClass</code> has | ||
* a value of <code>AFTER_1_ACCESS</code>.</p> | ||
* <p>This operation requires permissions for the | ||
@@ -578,4 +596,5 @@ * <code>elasticfilesystem:DescribeLifecycleConfiguration</code> operation.</p> | ||
/** | ||
* <p>Retrieves the replication configurations for either a specific file system, or all configurations for the | ||
* Amazon Web Services account in an Amazon Web Services Region if a file system is not specified.</p> | ||
* <p>Retrieves the replication configuration for a specific file system. If a file system is | ||
* not specified, all of the replication configurations for the Amazon Web Services account in an | ||
* Amazon Web Services Region are retrieved.</p> | ||
*/ | ||
@@ -589,4 +608,5 @@ describeReplicationConfigurations(args: DescribeReplicationConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeReplicationConfigurationsCommandOutput>; | ||
* <note> | ||
* <p>DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the | ||
* API action to remove tags from EFS resources.</p> | ||
* <p>DEPRECATED - The <code>DescribeTags</code> action is deprecated and not maintained. To view | ||
* tags associated with EFS resources, use the <code>ListTagsForResource</code> API | ||
* action.</p> | ||
* </note> | ||
@@ -642,4 +662,5 @@ * <p>Returns the tags associated with a file system. The order of tags returned in the | ||
* <note> | ||
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. | ||
* Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.</p> | ||
* <p>Starting in October, 2021, you will receive an error if you try to set the account preference | ||
* to use the short 8 character format resource ID. Contact Amazon Web Services support if you | ||
* receive an error and must use short IDs for file system and mount target resources.</p> | ||
* </note> | ||
@@ -674,8 +695,21 @@ */ | ||
/** | ||
* <p>Enables lifecycle management by creating a new <code>LifecycleConfiguration</code> | ||
* object. A <code>LifecycleConfiguration</code> object defines when files in an Amazon EFS file | ||
* system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. | ||
* To enable EFS Intelligent Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>. | ||
* For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>.</p> | ||
* <p>Use this action to manage EFS lifecycle management and intelligent tiering. A | ||
* <code>LifecycleConfiguration</code> consists of one or more <code>LifecyclePolicy</code> objects that | ||
* define the following:</p> | ||
* <ul> | ||
* <li> | ||
* <p> | ||
* <b>EFS Lifecycle management</b> - When Amazon EFS | ||
* automatically transitions files in a file system into the lower-cost Infrequent Access (IA) storage class.</p> | ||
* <p>To enable EFS Lifecycle management, set the value of <code>TransitionToIA</code> to one of the available options.</p> | ||
* </li> | ||
* <li> | ||
* <p> | ||
* <b>EFS Intelligent tiering</b> - When Amazon EFS | ||
* automatically transitions files from IA back into the file system's primary storage class (Standard or One Zone Standard.</p> | ||
* <p>To enable EFS Intelligent Tiering, set the value of <code>TransitionToPrimaryStorageClass</code> to <code>AFTER_1_ACCESS</code>.</p> | ||
* </li> | ||
* </ul> | ||
* | ||
* <p>For more information, see <a href="https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html">EFS Lifecycle Management</a>.</p> | ||
* <p>Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a | ||
@@ -686,23 +720,23 @@ * <code>LifecycleConfiguration</code> object already exists for the specified file system, a | ||
* array in the request body deletes any existing <code>LifecycleConfiguration</code> and | ||
* turns off lifecycle management for the file system.</p> | ||
* | ||
* | ||
* turns off lifecycle management and intelligent tiering for the file system.</p> | ||
* <p>In the request, specify the following: </p> | ||
* <ul> | ||
* <li> | ||
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.</p> | ||
* <p>The ID for the file system for which you are enabling, disabling, or modifying lifecycle management | ||
* and intelligent tiering.</p> | ||
* </li> | ||
* <li> | ||
* <p>A <code>LifecyclePolicies</code> array of <code>LifecyclePolicy</code> objects that | ||
* define when files are moved to the IA storage class. Amazon EFS requires that each <code>LifecyclePolicy</code> | ||
* define when files are moved into IA storage, and when they are moved back to Standard storage.</p> | ||
* <note> | ||
* <p>Amazon EFS requires that each <code>LifecyclePolicy</code> | ||
* object have only have a single transition, so the <code>LifecyclePolicies</code> array needs to be structured with separate | ||
* <code>LifecyclePolicy</code> objects. See the example requests in the following section for more information.</p> | ||
* </note> | ||
* </li> | ||
* </ul> | ||
* | ||
* <p>This operation requires permissions for the | ||
* <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p> | ||
* <p>This operation requires permissions for the <code>elasticfilesystem:PutLifecycleConfiguration</code> operation.</p> | ||
* <p>To apply a <code>LifecycleConfiguration</code> object to an encrypted file system, you | ||
* need the same Key Management Service permissions as when you created the encrypted | ||
* file system. </p> | ||
* need the same Key Management Service permissions as when you created the encrypted file system.</p> | ||
*/ | ||
@@ -709,0 +743,0 @@ putLifecycleConfiguration(args: PutLifecycleConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutLifecycleConfigurationCommandOutput>; |
@@ -160,6 +160,6 @@ import { EndpointsInputConfig, EndpointsResolvedConfig, RegionInputConfig, RegionResolvedConfig } from "@aws-sdk/config-resolver"; | ||
* <fullname>Amazon Elastic File System</fullname> | ||
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use | ||
* with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, | ||
* growing and shrinking automatically as you add and remove files, so your applications have the | ||
* storage they need, when they need it. For more information, see the <a href="https://docs.aws.amazon.com/efs/latest/ug/api-reference.html">Amazon Elastic File System API Reference</a> and the <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">Amazon Elastic File System User Guide</a>.</p> | ||
* <p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for | ||
* use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and | ||
* remove files, so that your applications have the storage they need, when they need it. For | ||
* more information, see the <a href="https://docs.aws.amazon.com/efs/latest/ug/api-reference.html">Amazon Elastic File System API Reference</a> and the <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">Amazon Elastic File System User Guide</a>.</p> | ||
*/ | ||
@@ -166,0 +166,0 @@ export declare class EFSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, EFSClientResolvedConfig> { |
@@ -214,2 +214,13 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client"; | ||
} | ||
export declare class ThrottlingException extends __BaseException { | ||
readonly name: "ThrottlingException"; | ||
readonly $fault: "client"; | ||
ErrorCode?: string; | ||
Message?: string; | ||
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>); | ||
} | ||
export declare enum PerformanceMode { | ||
@@ -216,0 +227,0 @@ GENERAL_PURPOSE = "generalPurpose", |
{ | ||
"name": "@aws-sdk/client-efs", | ||
"description": "AWS SDK for JavaScript Efs Client for Node.js, Browser and React Native", | ||
"version": "3.67.0", | ||
"version": "3.69.0", | ||
"scripts": { | ||
@@ -6,0 +6,0 @@ "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", |
@@ -12,6 +12,6 @@ # @aws-sdk/client-efs | ||
<p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use | ||
with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, | ||
growing and shrinking automatically as you add and remove files, so your applications have the | ||
storage they need, when they need it. For more information, see the <a href="https://docs.aws.amazon.com/efs/latest/ug/api-reference.html">Amazon Elastic File System API Reference</a> and the <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">Amazon Elastic File System User Guide</a>.</p> | ||
<p>Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for | ||
use with Amazon EC2 Linux and Mac instances in the Amazon Web Services Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and | ||
remove files, so that your applications have the storage they need, when they need it. For | ||
more information, see the <a href="https://docs.aws.amazon.com/efs/latest/ug/api-reference.html">Amazon Elastic File System API Reference</a> and the <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">Amazon Elastic File System User Guide</a>.</p> | ||
@@ -18,0 +18,0 @@ ## Installing |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
1195406
20663