UNPKG

73.9 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class EFS extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: EFS.Types.ClientConfiguration)
13 config: Config & EFS.Types.ClientConfiguration;
14 /**
15 * Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group 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 Mounting a File System Using EFS Access Points. This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
16 */
17 createAccessPoint(params: EFS.Types.CreateAccessPointRequest, callback?: (err: AWSError, data: EFS.Types.AccessPointDescription) => void): Request<EFS.Types.AccessPointDescription, AWSError>;
18 /**
19 * Creates an EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point. The operating system user and group 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 Mounting a File System Using EFS Access Points. This operation requires permissions for the elasticfilesystem:CreateAccessPoint action.
20 */
21 createAccessPoint(callback?: (err: AWSError, data: EFS.Types.AccessPointDescription) => void): Request<EFS.Types.AccessPointDescription, AWSError>;
22 /**
23 * Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token. The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error. The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state. This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes. After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works. This operation requires permissions for the elasticfilesystem:CreateFileSystem action.
24 */
25 createFileSystem(params: EFS.Types.CreateFileSystemRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
26 /**
27 * Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating. Returns with the description of the created file system. Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system. For basic use cases, you can use a randomly generated UUID for the creation token. The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error. The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state. This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes. After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works. This operation requires permissions for the elasticfilesystem:CreateFileSystem action.
28 */
29 createFileSystem(callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
30 /**
31 * Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works. In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems. In the request, you also provide a subnet ID, which determines the following: VPC in which Amazon EFS creates the mount target Availability Zone in which Amazon EFS creates the mount target IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request) After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview. Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements: Must belong to the same VPC as the subnets of the existing mount targets Must not be in the same Availability Zone as any of the subnets of the existing mount targets If the request satisfies the requirements, Amazon EFS does the following: Creates a new mount target in the specified subnet. Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state. We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:CreateMountTarget This operation also requires permissions for the following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface
32 */
33 createMountTarget(params: EFS.Types.CreateMountTargetRequest, callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request<EFS.Types.MountTargetDescription, AWSError>;
34 /**
35 * Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target. You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works. In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems. In the request, you also provide a subnet ID, which determines the following: VPC in which Amazon EFS creates the mount target Availability Zone in which Amazon EFS creates the mount target IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request) After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview. Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements: Must belong to the same VPC as the subnets of the existing mount targets Must not be in the same Availability Zone as any of the subnets of the existing mount targets If the request satisfies the requirements, Amazon EFS does the following: Creates a new mount target in the specified subnet. Also creates a new network interface in the subnet as follows: If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address). If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC. Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId. Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS. Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails. The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state. We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:CreateMountTarget This operation also requires permissions for the following Amazon EC2 actions: ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface
36 */
37 createMountTarget(callback?: (err: AWSError, data: EFS.Types.MountTargetDescription) => void): Request<EFS.Types.MountTargetDescription, AWSError>;
38 /**
39 * Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation. This operation requires permission for the elasticfilesystem:CreateTags action.
40 */
41 createTags(params: EFS.Types.CreateTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
42 /**
43 * Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation. This operation requires permission for the elasticfilesystem:CreateTags action.
44 */
45 createTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
46 /**
47 * Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection. This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.
48 */
49 deleteAccessPoint(params: EFS.Types.DeleteAccessPointRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50 /**
51 * Deletes the specified access point. After deletion is complete, new clients can no longer connect to the access points. Clients connected to the access point at the time of deletion will continue to function until they terminate their connection. This operation requires permissions for the elasticfilesystem:DeleteAccessPoint action.
52 */
53 deleteAccessPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54 /**
55 * Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system. You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget. The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error. This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.
56 */
57 deleteFileSystem(params: EFS.Types.DeleteFileSystemRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58 /**
59 * Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system. You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget. The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error. This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.
60 */
61 deleteFileSystem(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62 /**
63 * Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS. This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.
64 */
65 deleteFileSystemPolicy(params: EFS.Types.DeleteFileSystemPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66 /**
67 * Deletes the FileSystemPolicy for the specified file system. The default FileSystemPolicy goes into effect once the existing policy is deleted. For more information about the default file system policy, see Using Resource-based Policies with EFS. This operation requires permissions for the elasticfilesystem:DeleteFileSystemPolicy action.
68 */
69 deleteFileSystemPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
70 /**
71 * Deletes the specified mount target. This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system. The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface: ec2:DeleteNetworkInterface
72 */
73 deleteMountTarget(params: EFS.Types.DeleteMountTargetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
74 /**
75 * Deletes the specified mount target. This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target. This operation requires permissions for the following action on the file system: elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system. The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface: ec2:DeleteNetworkInterface
76 */
77 deleteMountTarget(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78 /**
79 * Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide. This operation requires permissions for the elasticfilesystem:DeleteTags action.
80 */
81 deleteTags(params: EFS.Types.DeleteTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82 /**
83 * Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide. This operation requires permissions for the elasticfilesystem:DeleteTags action.
84 */
85 deleteTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86 /**
87 * Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
88 */
89 describeAccessPoints(params: EFS.Types.DescribeAccessPointsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeAccessPointsResponse) => void): Request<EFS.Types.DescribeAccessPointsResponse, AWSError>;
90 /**
91 * Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
92 */
93 describeAccessPoints(callback?: (err: AWSError, data: EFS.Types.DescribeAccessPointsResponse) => void): Request<EFS.Types.DescribeAccessPointsResponse, AWSError>;
94 /**
95 * Returns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
96 */
97 describeFileSystemPolicy(params: EFS.Types.DescribeFileSystemPolicyRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
98 /**
99 * Returns the FileSystemPolicy for the specified EFS file system. This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.
100 */
101 describeFileSystemPolicy(callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
102 /**
103 * Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker. To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified. This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.
104 */
105 describeFileSystems(params: EFS.Types.DescribeFileSystemsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeFileSystemsResponse) => void): Request<EFS.Types.DescribeFileSystemsResponse, AWSError>;
106 /**
107 * Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling. When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker. To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker. The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified. This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.
108 */
109 describeFileSystems(callback?: (err: AWSError, data: EFS.Types.DescribeFileSystemsResponse) => void): Request<EFS.Types.DescribeFileSystemsResponse, AWSError>;
110 /**
111 * Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.
112 */
113 describeLifecycleConfiguration(params: EFS.Types.DescribeLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
114 /**
115 * Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response. This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.
116 */
117 describeLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
118 /**
119 * Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. This operation requires permissions for the following actions: elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system. ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.
120 */
121 describeMountTargetSecurityGroups(params: EFS.Types.DescribeMountTargetSecurityGroupsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetSecurityGroupsResponse) => void): Request<EFS.Types.DescribeMountTargetSecurityGroupsResponse, AWSError>;
122 /**
123 * Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. This operation requires permissions for the following actions: elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system. ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.
124 */
125 describeMountTargetSecurityGroups(callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetSecurityGroupsResponse) => void): Request<EFS.Types.DescribeMountTargetSecurityGroupsResponse, AWSError>;
126 /**
127 * Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified. This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.
128 */
129 describeMountTargets(params: EFS.Types.DescribeMountTargetsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetsResponse) => void): Request<EFS.Types.DescribeMountTargetsResponse, AWSError>;
130 /**
131 * Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified. This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.
132 */
133 describeMountTargets(callback?: (err: AWSError, data: EFS.Types.DescribeMountTargetsResponse) => void): Request<EFS.Types.DescribeMountTargetsResponse, AWSError>;
134 /**
135 * Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. This operation requires permissions for the elasticfilesystem:DescribeTags action.
136 */
137 describeTags(params: EFS.Types.DescribeTagsRequest, callback?: (err: AWSError, data: EFS.Types.DescribeTagsResponse) => void): Request<EFS.Types.DescribeTagsResponse, AWSError>;
138 /**
139 * Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified. This operation requires permissions for the elasticfilesystem:DescribeTags action.
140 */
141 describeTags(callback?: (err: AWSError, data: EFS.Types.DescribeTagsResponse) => void): Request<EFS.Types.DescribeTagsResponse, AWSError>;
142 /**
143 * Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
144 */
145 listTagsForResource(params: EFS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: EFS.Types.ListTagsForResourceResponse) => void): Request<EFS.Types.ListTagsForResourceResponse, AWSError>;
146 /**
147 * Lists all tags for a top-level EFS resource. You must provide the ID of the resource that you want to retrieve the tags for. This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.
148 */
149 listTagsForResource(callback?: (err: AWSError, data: EFS.Types.ListTagsForResourceResponse) => void): Request<EFS.Types.ListTagsForResourceResponse, AWSError>;
150 /**
151 * Modifies the set of security groups in effect for a mount target. When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. The operation requires permissions for the following actions: elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system. ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.
152 */
153 modifyMountTargetSecurityGroups(params: EFS.Types.ModifyMountTargetSecurityGroupsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
154 /**
155 * Modifies the set of security groups in effect for a mount target. When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted. The operation requires permissions for the following actions: elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system. ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.
156 */
157 modifyMountTargetSecurityGroups(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
158 /**
159 * Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy. This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
160 */
161 putFileSystemPolicy(params: EFS.Types.PutFileSystemPolicyRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
162 /**
163 * Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. A file system policy is an IAM resource-based policy and can contain multiple policy statements. A file system always has exactly one file system policy, which can be the default policy or an explicit policy set or updated using this API operation. When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see Default EFS File System Policy. This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
164 */
165 putFileSystemPolicy(callback?: (err: AWSError, data: EFS.Types.FileSystemPolicyDescription) => void): Request<EFS.Types.FileSystemPolicyDescription, AWSError>;
166 /**
167 * Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and disables lifecycle management. In the request, specify the following: The ID for the file system for which you are enabling, disabling, or modifying lifecycle management. A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one LifecyclePolicy item. This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system.
168 */
169 putLifecycleConfiguration(params: EFS.Types.PutLifecycleConfigurationRequest, callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
170 /**
171 * Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system. Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and disables lifecycle management. In the request, specify the following: The ID for the file system for which you are enabling, disabling, or modifying lifecycle management. A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one LifecyclePolicy item. This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation. To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system.
172 */
173 putLifecycleConfiguration(callback?: (err: AWSError, data: EFS.Types.LifecycleConfigurationDescription) => void): Request<EFS.Types.LifecycleConfigurationDescription, AWSError>;
174 /**
175 * Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation. This operation requires permissions for the elasticfilesystem:TagResource action.
176 */
177 tagResource(params: EFS.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
178 /**
179 * Creates a tag for an EFS resource. You can create tags for EFS file systems and access points using this API operation. This operation requires permissions for the elasticfilesystem:TagResource action.
180 */
181 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
182 /**
183 * Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation. This operation requires permissions for the elasticfilesystem:UntagResource action.
184 */
185 untagResource(params: EFS.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
186 /**
187 * Removes tags from an EFS resource. You can remove tags from EFS file systems and access points using this API operation. This operation requires permissions for the elasticfilesystem:UntagResource action.
188 */
189 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
190 /**
191 * Updates the throughput mode or the amount of provisioned throughput of an existing file system.
192 */
193 updateFileSystem(params: EFS.Types.UpdateFileSystemRequest, callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
194 /**
195 * Updates the throughput mode or the amount of provisioned throughput of an existing file system.
196 */
197 updateFileSystem(callback?: (err: AWSError, data: EFS.Types.FileSystemDescription) => void): Request<EFS.Types.FileSystemDescription, AWSError>;
198}
199declare namespace EFS {
200 export type AccessPointArn = string;
201 export interface AccessPointDescription {
202 /**
203 * The opaque string specified in the request to ensure idempotent creation.
204 */
205 ClientToken?: ClientToken;
206 /**
207 * The name of the access point. This is the value of the Name tag.
208 */
209 Name?: Name;
210 /**
211 * The tags associated with the access point, presented as an array of Tag objects.
212 */
213 Tags?: Tags;
214 /**
215 * The ID of the access point, assigned by Amazon EFS.
216 */
217 AccessPointId?: AccessPointId;
218 /**
219 * The unique Amazon Resource Name (ARN) associated with the access point.
220 */
221 AccessPointArn?: AccessPointArn;
222 /**
223 * The ID of the EFS file system that the access point applies to.
224 */
225 FileSystemId?: FileSystemId;
226 /**
227 * The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is used for all file operations by NFS clients using the access point.
228 */
229 PosixUser?: PosixUser;
230 /**
231 * The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
232 */
233 RootDirectory?: RootDirectory;
234 /**
235 * Identified the AWS account that owns the access point resource.
236 */
237 OwnerId?: AwsAccountId;
238 /**
239 * Identifies the lifecycle phase of the access point.
240 */
241 LifeCycleState?: LifeCycleState;
242 }
243 export type AccessPointDescriptions = AccessPointDescription[];
244 export type AccessPointId = string;
245 export type AvailabilityZoneId = string;
246 export type AvailabilityZoneName = string;
247 export type AwsAccountId = string;
248 export type BypassPolicyLockoutSafetyCheck = boolean;
249 export type ClientToken = string;
250 export interface CreateAccessPointRequest {
251 /**
252 * A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
253 */
254 ClientToken: ClientToken;
255 /**
256 * Creates tags associated with the access point. Each tag is a key-value pair.
257 */
258 Tags?: Tags;
259 /**
260 * The ID of the EFS file system that the access point provides access to.
261 */
262 FileSystemId: FileSystemId;
263 /**
264 * The operating system user and group applied to all file system requests made using the access point.
265 */
266 PosixUser?: PosixUser;
267 /**
268 * Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your file system to NFS clients using the access point. The clients using the access point can only access the root directory and below. If the RootDirectory &gt; Path specified does not exist, EFS creates it and applies the CreationInfo settings when a client connects to an access point. When specifying a RootDirectory, you need to provide the Path, and the CreationInfo is optional.
269 */
270 RootDirectory?: RootDirectory;
271 }
272 export interface CreateFileSystemRequest {
273 /**
274 * A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
275 */
276 CreationToken: CreationToken;
277 /**
278 * The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.
279 */
280 PerformanceMode?: PerformanceMode;
281 /**
282 * A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.
283 */
284 Encrypted?: Encrypted;
285 /**
286 * The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats: Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab. ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. Key alias - A previously created display name for a key, for example alias/projectKey1. Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1. If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true. EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with EFS file systems.
287 */
288 KmsKeyId?: KmsKeyId;
289 /**
290 * The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.
291 */
292 ThroughputMode?: ThroughputMode;
293 /**
294 * The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
295 */
296 ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
297 /**
298 * A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}" key-value pair.
299 */
300 Tags?: Tags;
301 }
302 export interface CreateMountTargetRequest {
303 /**
304 * The ID of the file system for which to create the mount target.
305 */
306 FileSystemId: FileSystemId;
307 /**
308 * The ID of the subnet to add the mount target in.
309 */
310 SubnetId: SubnetId;
311 /**
312 * Valid IPv4 address within the address range of the specified subnet.
313 */
314 IpAddress?: IpAddress;
315 /**
316 * Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.
317 */
318 SecurityGroups?: SecurityGroups;
319 }
320 export interface CreateTagsRequest {
321 /**
322 * The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.
323 */
324 FileSystemId: FileSystemId;
325 /**
326 * An array of Tag objects to add. Each Tag object is a key-value pair.
327 */
328 Tags: Tags;
329 }
330 export interface CreationInfo {
331 /**
332 * Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
333 */
334 OwnerUid: OwnerUid;
335 /**
336 * Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32 (4294967295).
337 */
338 OwnerGid: OwnerGid;
339 /**
340 * Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.
341 */
342 Permissions: Permissions;
343 }
344 export type CreationToken = string;
345 export interface DeleteAccessPointRequest {
346 /**
347 * The ID of the access point that you want to delete.
348 */
349 AccessPointId: AccessPointId;
350 }
351 export interface DeleteFileSystemPolicyRequest {
352 /**
353 * Specifies the EFS file system for which to delete the FileSystemPolicy.
354 */
355 FileSystemId: FileSystemId;
356 }
357 export interface DeleteFileSystemRequest {
358 /**
359 * The ID of the file system you want to delete.
360 */
361 FileSystemId: FileSystemId;
362 }
363 export interface DeleteMountTargetRequest {
364 /**
365 * The ID of the mount target to delete (String).
366 */
367 MountTargetId: MountTargetId;
368 }
369 export interface DeleteTagsRequest {
370 /**
371 * The ID of the file system whose tags you want to delete (String).
372 */
373 FileSystemId: FileSystemId;
374 /**
375 * A list of tag keys to delete.
376 */
377 TagKeys: TagKeys;
378 }
379 export interface DescribeAccessPointsRequest {
380 /**
381 * (Optional) When retrieving all access points for a file system, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.
382 */
383 MaxResults?: MaxResults;
384 /**
385 * NextToken is present if the response is paginated. You can use NextMarker in the subsequent request to fetch the next page of access point descriptions.
386 */
387 NextToken?: Token;
388 /**
389 * (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.
390 */
391 AccessPointId?: AccessPointId;
392 /**
393 * (Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.
394 */
395 FileSystemId?: FileSystemId;
396 }
397 export interface DescribeAccessPointsResponse {
398 /**
399 * An array of access point descriptions.
400 */
401 AccessPoints?: AccessPointDescriptions;
402 /**
403 * Present if there are more access points than returned in the response. You can use the NextMarker in the subsequent request to fetch the additional descriptions.
404 */
405 NextToken?: Token;
406 }
407 export interface DescribeFileSystemPolicyRequest {
408 /**
409 * Specifies which EFS file system to retrieve the FileSystemPolicy for.
410 */
411 FileSystemId: FileSystemId;
412 }
413 export interface DescribeFileSystemsRequest {
414 /**
415 * (Optional) Specifies the maximum number of file systems to return in the response (integer). This number is automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.
416 */
417 MaxItems?: MaxItems;
418 /**
419 * (Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.
420 */
421 Marker?: Marker;
422 /**
423 * (Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.
424 */
425 CreationToken?: CreationToken;
426 /**
427 * (Optional) ID of the file system whose description you want to retrieve (String).
428 */
429 FileSystemId?: FileSystemId;
430 }
431 export interface DescribeFileSystemsResponse {
432 /**
433 * Present if provided by caller in the request (String).
434 */
435 Marker?: Marker;
436 /**
437 * An array of file system descriptions.
438 */
439 FileSystems?: FileSystemDescriptions;
440 /**
441 * Present if there are more file systems than returned in the response (String). You can use the NextMarker in the subsequent request to fetch the descriptions.
442 */
443 NextMarker?: Marker;
444 }
445 export interface DescribeLifecycleConfigurationRequest {
446 /**
447 * The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).
448 */
449 FileSystemId: FileSystemId;
450 }
451 export interface DescribeMountTargetSecurityGroupsRequest {
452 /**
453 * The ID of the mount target whose security groups you want to retrieve.
454 */
455 MountTargetId: MountTargetId;
456 }
457 export interface DescribeMountTargetSecurityGroupsResponse {
458 /**
459 * An array of security groups.
460 */
461 SecurityGroups: SecurityGroups;
462 }
463 export interface DescribeMountTargetsRequest {
464 /**
465 * (Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount targets.
466 */
467 MaxItems?: MaxItems;
468 /**
469 * (Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String). If present, it specifies to continue the list from where the previous returning call left off.
470 */
471 Marker?: Marker;
472 /**
473 * (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if an AccessPointId or MountTargetId is not included. Accepts either a file system ID or ARN as input.
474 */
475 FileSystemId?: FileSystemId;
476 /**
477 * (Optional) ID of the mount target that you want to have described (String). It must be included in your request if FileSystemId is not included. Accepts either a mount target ID or ARN as input.
478 */
479 MountTargetId?: MountTargetId;
480 /**
481 * (Optional) The ID of the access point whose mount targets that you want to list. It must be included in your request if a FileSystemId or MountTargetId is not included in your request. Accepts either an access point ID or ARN as input.
482 */
483 AccessPointId?: AccessPointId;
484 }
485 export interface DescribeMountTargetsResponse {
486 /**
487 * If the request included the Marker, the response returns that value in this field.
488 */
489 Marker?: Marker;
490 /**
491 * Returns the file system's mount targets as an array of MountTargetDescription objects.
492 */
493 MountTargets?: MountTargetDescriptions;
494 /**
495 * If a value is present, there are more mount targets to return. In a subsequent request, you can provide Marker in your request with this value to retrieve the next set of mount targets.
496 */
497 NextMarker?: Marker;
498 }
499 export interface DescribeTagsRequest {
500 /**
501 * (Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have more than 100 tags.
502 */
503 MaxItems?: MaxItems;
504 /**
505 * (Optional) An opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.
506 */
507 Marker?: Marker;
508 /**
509 * The ID of the file system whose tag set you want to retrieve.
510 */
511 FileSystemId: FileSystemId;
512 }
513 export interface DescribeTagsResponse {
514 /**
515 * If the request included a Marker, the response returns that value in this field.
516 */
517 Marker?: Marker;
518 /**
519 * Returns tags associated with the file system as an array of Tag objects.
520 */
521 Tags: Tags;
522 /**
523 * If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags.
524 */
525 NextMarker?: Marker;
526 }
527 export type Encrypted = boolean;
528 export interface FileSystemDescription {
529 /**
530 * The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.
531 */
532 OwnerId: AwsAccountId;
533 /**
534 * The opaque string specified in the request.
535 */
536 CreationToken: CreationToken;
537 /**
538 * The ID of the file system, assigned by Amazon EFS.
539 */
540 FileSystemId: FileSystemId;
541 /**
542 * The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
543 */
544 CreationTime: Timestamp;
545 /**
546 * The lifecycle phase of the file system.
547 */
548 LifeCycleState: LifeCycleState;
549 /**
550 * You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.
551 */
552 Name?: TagValue;
553 /**
554 * The current number of mount targets that the file system has. For more information, see CreateMountTarget.
555 */
556 NumberOfMountTargets: MountTargetCount;
557 /**
558 * The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.
559 */
560 SizeInBytes: FileSystemSize;
561 /**
562 * The performance mode of the file system.
563 */
564 PerformanceMode: PerformanceMode;
565 /**
566 * A Boolean value that, if true, indicates that the file system is encrypted.
567 */
568 Encrypted?: Encrypted;
569 /**
570 * The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.
571 */
572 KmsKeyId?: KmsKeyId;
573 /**
574 * The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.
575 */
576 ThroughputMode?: ThroughputMode;
577 /**
578 * The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.
579 */
580 ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
581 /**
582 * The tags associated with the file system, presented as an array of Tag objects.
583 */
584 Tags: Tags;
585 }
586 export type FileSystemDescriptions = FileSystemDescription[];
587 export type FileSystemId = string;
588 export type FileSystemNullableSizeValue = number;
589 export interface FileSystemPolicyDescription {
590 /**
591 * Specifies the EFS file system to which the FileSystemPolicy applies.
592 */
593 FileSystemId?: FileSystemId;
594 /**
595 * The JSON formatted FileSystemPolicy for the EFS file system.
596 */
597 Policy?: Policy;
598 }
599 export interface FileSystemSize {
600 /**
601 * The latest known metered size (in bytes) of data stored in the file system.
602 */
603 Value: FileSystemSizeValue;
604 /**
605 * The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.
606 */
607 Timestamp?: Timestamp;
608 /**
609 * The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
610 */
611 ValueInIA?: FileSystemNullableSizeValue;
612 /**
613 * The latest known metered size (in bytes) of data stored in the Standard storage class.
614 */
615 ValueInStandard?: FileSystemNullableSizeValue;
616 }
617 export type FileSystemSizeValue = number;
618 export type Gid = number;
619 export type IpAddress = string;
620 export type KmsKeyId = string;
621 export type LifeCycleState = "creating"|"available"|"updating"|"deleting"|"deleted"|string;
622 export interface LifecycleConfigurationDescription {
623 /**
624 * An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system.
625 */
626 LifecyclePolicies?: LifecyclePolicies;
627 }
628 export type LifecyclePolicies = LifecyclePolicy[];
629 export interface LifecyclePolicy {
630 /**
631 * A value that describes the period of time that a file is not accessed, after which it transitions to the IA storage class. Metadata operations such as listing the contents of a directory don't count as file access events.
632 */
633 TransitionToIA?: TransitionToIARules;
634 }
635 export interface ListTagsForResourceRequest {
636 /**
637 * Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access points using this API endpoint.
638 */
639 ResourceId: ResourceId;
640 /**
641 * (Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.
642 */
643 MaxResults?: MaxResults;
644 /**
645 * You can use NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.
646 */
647 NextToken?: Token;
648 }
649 export interface ListTagsForResourceResponse {
650 /**
651 * An array of the tags for the specified EFS resource.
652 */
653 Tags?: Tags;
654 /**
655 * NextToken is present if the response payload is paginated. You can use NextToken in a subsequent request to fetch the next page of access point descriptions.
656 */
657 NextToken?: Token;
658 }
659 export type Marker = string;
660 export type MaxItems = number;
661 export type MaxResults = number;
662 export interface ModifyMountTargetSecurityGroupsRequest {
663 /**
664 * The ID of the mount target whose security groups you want to modify.
665 */
666 MountTargetId: MountTargetId;
667 /**
668 * An array of up to five VPC security group IDs.
669 */
670 SecurityGroups?: SecurityGroups;
671 }
672 export type MountTargetCount = number;
673 export interface MountTargetDescription {
674 /**
675 * AWS account ID that owns the resource.
676 */
677 OwnerId?: AwsAccountId;
678 /**
679 * System-assigned mount target ID.
680 */
681 MountTargetId: MountTargetId;
682 /**
683 * The ID of the file system for which the mount target is intended.
684 */
685 FileSystemId: FileSystemId;
686 /**
687 * The ID of the mount target's subnet.
688 */
689 SubnetId: SubnetId;
690 /**
691 * Lifecycle state of the mount target.
692 */
693 LifeCycleState: LifeCycleState;
694 /**
695 * Address at which the file system can be mounted by using the mount target.
696 */
697 IpAddress?: IpAddress;
698 /**
699 * The ID of the network interface that Amazon EFS created when it created the mount target.
700 */
701 NetworkInterfaceId?: NetworkInterfaceId;
702 /**
703 * The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every AWS account.
704 */
705 AvailabilityZoneId?: AvailabilityZoneId;
706 /**
707 * The name of the Availability Zone (AZ) that the mount target resides in. AZs are independently mapped to names for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not be the same location as us-east-1a for another AWS account.
708 */
709 AvailabilityZoneName?: AvailabilityZoneName;
710 }
711 export type MountTargetDescriptions = MountTargetDescription[];
712 export type MountTargetId = string;
713 export type Name = string;
714 export type NetworkInterfaceId = string;
715 export type OwnerGid = number;
716 export type OwnerUid = number;
717 export type Path = string;
718 export type PerformanceMode = "generalPurpose"|"maxIO"|string;
719 export type Permissions = string;
720 export type Policy = string;
721 export interface PosixUser {
722 /**
723 * The POSIX user ID used for all file system operations using this access point.
724 */
725 Uid: Uid;
726 /**
727 * The POSIX group ID used for all file system operations using this access point.
728 */
729 Gid: Gid;
730 /**
731 * Secondary POSIX group IDs used for all file system operations using this access point.
732 */
733 SecondaryGids?: SecondaryGids;
734 }
735 export type ProvisionedThroughputInMibps = number;
736 export interface PutFileSystemPolicyRequest {
737 /**
738 * The ID of the EFS file system that you want to create or update the FileSystemPolicy for.
739 */
740 FileSystemId: FileSystemId;
741 /**
742 * The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. To find out more about the elements that make up a file system policy, see EFS Resource-based Policies.
743 */
744 Policy: Policy;
745 /**
746 * (Optional) A flag to indicate whether to bypass the FileSystemPolicy lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request will be locked out from making future PutFileSystemPolicy requests on the file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the principal that is making the request from making a subsequent PutFileSystemPolicy request on the file system. The default value is False.
747 */
748 BypassPolicyLockoutSafetyCheck?: BypassPolicyLockoutSafetyCheck;
749 }
750 export interface PutLifecycleConfigurationRequest {
751 /**
752 * The ID of the file system for which you are creating the LifecycleConfiguration object (String).
753 */
754 FileSystemId: FileSystemId;
755 /**
756 * An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object tells lifecycle management when to transition files from the Standard storage class to the Infrequent Access storage class.
757 */
758 LifecyclePolicies: LifecyclePolicies;
759 }
760 export type ResourceId = string;
761 export interface RootDirectory {
762 /**
763 * Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide the CreationInfo.
764 */
765 Path?: Path;
766 /**
767 * (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory &gt; Path specified does not exist, EFS creates the root directory using the CreationInfo settings when a client connects to an access point. When specifying the CreationInfo, you must provide values for all properties. If you do not provide CreationInfo and the specified RootDirectory &gt; Path does not exist, attempts to mount the file system using the access point will fail.
768 */
769 CreationInfo?: CreationInfo;
770 }
771 export type SecondaryGids = Gid[];
772 export type SecurityGroup = string;
773 export type SecurityGroups = SecurityGroup[];
774 export type SubnetId = string;
775 export interface Tag {
776 /**
777 * The tag key (String). The key can't start with aws:.
778 */
779 Key: TagKey;
780 /**
781 * The value of the tag key.
782 */
783 Value: TagValue;
784 }
785 export type TagKey = string;
786 export type TagKeys = TagKey[];
787 export interface TagResourceRequest {
788 /**
789 * The ID specifying the EFS resource that you want to create a tag for.
790 */
791 ResourceId: ResourceId;
792 /**
793 *
794 */
795 Tags: Tags;
796 }
797 export type TagValue = string;
798 export type Tags = Tag[];
799 export type ThroughputMode = "bursting"|"provisioned"|string;
800 export type Timestamp = Date;
801 export type Token = string;
802 export type TransitionToIARules = "AFTER_7_DAYS"|"AFTER_14_DAYS"|"AFTER_30_DAYS"|"AFTER_60_DAYS"|"AFTER_90_DAYS"|string;
803 export type Uid = number;
804 export interface UntagResourceRequest {
805 /**
806 * Specifies the EFS resource that you want to remove tags from.
807 */
808 ResourceId: ResourceId;
809 /**
810 * The keys of the key:value tag pairs that you want to remove from the specified EFS resource.
811 */
812 TagKeys?: TagKeys;
813 }
814 export interface UpdateFileSystemRequest {
815 /**
816 * The ID of the file system that you want to update.
817 */
818 FileSystemId: FileSystemId;
819 /**
820 * (Optional) The throughput mode that you want your file system to use. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.
821 */
822 ThroughputMode?: ThroughputMode;
823 /**
824 * (Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are 1-1024. Required if ThroughputMode is changed to provisioned on update. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request.
825 */
826 ProvisionedThroughputInMibps?: ProvisionedThroughputInMibps;
827 }
828 /**
829 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
830 */
831 export type apiVersion = "2015-02-01"|"latest"|string;
832 export interface ClientApiVersions {
833 /**
834 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
835 */
836 apiVersion?: apiVersion;
837 }
838 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
839 /**
840 * Contains interfaces for use with the EFS client.
841 */
842 export import Types = EFS;
843}
844export = EFS;