5.0.0 • Published 7 years ago
@datafire/amazonaws_elasticfilesystem v5.0.0
@datafire/amazonaws_elasticfilesystem
Client library for Amazon Elastic File System
Installation and Usage
npm install --save @datafire/amazonaws_elasticfilesystem
let amazonaws_elasticfilesystem = require('@datafire/amazonaws_elasticfilesystem').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_elasticfilesystem.CreateTags({
"FileSystemId": "",
"Tags": []
}).then(data => {
console.log(data);
});
Description
Amazon Elastic File System Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS 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 User Guide.
Actions
CreateTags
amazonaws_elasticfilesystem.CreateTags({
"FileSystemId": "",
"Tags": []
}, context)
Input
- input
object
- FileSystemId required
string
- Tags required Tags
- FileSystemId required
Output
Output schema unknown
DeleteTags
amazonaws_elasticfilesystem.DeleteTags({
"FileSystemId": "",
"TagKeys": []
}, context)
Input
- input
object
- FileSystemId required
string
- TagKeys required TagKeys
- FileSystemId required
Output
Output schema unknown
DescribeFileSystems
amazonaws_elasticfilesystem.DescribeFileSystems({}, context)
Input
- input
object
Output
- output DescribeFileSystemsResponse
CreateFileSystem
amazonaws_elasticfilesystem.CreateFileSystem({
"CreationToken": ""
}, context)
Input
- input
object
- CreationToken required CreationToken
- Encrypted Encrypted
- KmsKeyId KmsKeyId
- PerformanceMode PerformanceMode
Output
Output schema unknown
DeleteFileSystem
amazonaws_elasticfilesystem.DeleteFileSystem({
"FileSystemId": ""
}, context)
Input
- input
object
- FileSystemId required
string
- FileSystemId required
Output
Output schema unknown
DescribeMountTargets
amazonaws_elasticfilesystem.DescribeMountTargets({}, context)
Input
- input
object
Output
- output DescribeMountTargetsResponse
CreateMountTarget
amazonaws_elasticfilesystem.CreateMountTarget({
"FileSystemId": "",
"SubnetId": ""
}, context)
Input
- input
object
- FileSystemId required FileSystemId
- IpAddress IpAddress
- SecurityGroups SecurityGroups
- SubnetId required SubnetId
Output
- output MountTargetDescription
DeleteMountTarget
amazonaws_elasticfilesystem.DeleteMountTarget({
"MountTargetId": ""
}, context)
Input
- input
object
- MountTargetId required
string
- MountTargetId required
Output
Output schema unknown
DescribeMountTargetSecurityGroups
amazonaws_elasticfilesystem.DescribeMountTargetSecurityGroups({
"MountTargetId": ""
}, context)
Input
- input
object
- MountTargetId required
string
- MountTargetId required
Output
ModifyMountTargetSecurityGroups
amazonaws_elasticfilesystem.ModifyMountTargetSecurityGroups({
"MountTargetId": ""
}, context)
Input
- input
object
- MountTargetId required
string
- SecurityGroups SecurityGroups
- MountTargetId required
Output
Output schema unknown
DescribeTags
amazonaws_elasticfilesystem.DescribeTags({
"FileSystemId": ""
}, context)
Input
- input
object
- FileSystemId required
string
- FileSystemId required
Output
- output DescribeTagsResponse
Definitions
AwsAccountId
- AwsAccountId
string
BadRequest
- BadRequest
object
: Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.- ErrorCode required ErrorCode
- Message ErrorMessage
CreateFileSystemRequest
- CreateFileSystemRequest
object
- CreationToken required CreationToken
- Encrypted Encrypted
- KmsKeyId KmsKeyId
- PerformanceMode PerformanceMode
CreateMountTargetRequest
- CreateMountTargetRequest
object
:- FileSystemId required FileSystemId
- IpAddress IpAddress
- SecurityGroups SecurityGroups
- SubnetId required SubnetId
CreateTagsRequest
- CreateTagsRequest
object
:- Tags required Tags
CreationToken
- CreationToken
string
DeleteFileSystemRequest
- DeleteFileSystemRequest
object
:
DeleteMountTargetRequest
- DeleteMountTargetRequest
object
:
DeleteTagsRequest
- DeleteTagsRequest
object
:- TagKeys required TagKeys
DependencyTimeout
- DependencyTimeout
object
: The service timed out trying to fulfill the request, and the client should try the call again.- ErrorCode required ErrorCode
- Message ErrorMessage
DescribeFileSystemsRequest
- DescribeFileSystemsRequest
object
:
DescribeFileSystemsResponse
- DescribeFileSystemsResponse
object
- FileSystems FileSystemDescriptions
- Marker Marker
- NextMarker Marker
DescribeMountTargetSecurityGroupsRequest
- DescribeMountTargetSecurityGroupsRequest
object
:
DescribeMountTargetSecurityGroupsResponse
- DescribeMountTargetSecurityGroupsResponse
object
- SecurityGroups required SecurityGroups
DescribeMountTargetsRequest
- DescribeMountTargetsRequest
object
:
DescribeMountTargetsResponse
- DescribeMountTargetsResponse
object
:- Marker Marker
- MountTargets MountTargetDescriptions
- NextMarker Marker
DescribeTagsRequest
- DescribeTagsRequest
object
:
DescribeTagsResponse
Encrypted
- Encrypted
boolean
ErrorCode
- ErrorCode
string
ErrorMessage
- ErrorMessage
string
FileSystemAlreadyExists
- FileSystemAlreadyExists
object
: Returned if the file system you are trying to create already exists, with the creation token you provided.- ErrorCode required ErrorCode
- FileSystemId required FileSystemId
- Message ErrorMessage
FileSystemDescription
- FileSystemDescription
object
: Description of the file system.- CreationTime required Timestamp
- CreationToken required CreationToken
- Encrypted Encrypted
- FileSystemId required FileSystemId
- KmsKeyId KmsKeyId
- LifeCycleState required LifeCycleState
- Name TagValue
- NumberOfMountTargets required MountTargetCount
- OwnerId required AwsAccountId
- PerformanceMode required PerformanceMode
- SizeInBytes required FileSystemSize
FileSystemDescriptions
- FileSystemDescriptions
array
- items FileSystemDescription
FileSystemId
- FileSystemId
string
FileSystemInUse
- FileSystemInUse
object
: Returned if a file system has mount targets.- ErrorCode required ErrorCode
- Message ErrorMessage
FileSystemLimitExceeded
- FileSystemLimitExceeded
object
: Returned if the AWS account has already created maximum number of file systems allowed per account.- ErrorCode required ErrorCode
- Message ErrorMessage
FileSystemNotFound
- FileSystemNotFound
object
: Returned if the specified FileSystemId does not exist in the requester's AWS account.- ErrorCode required ErrorCode
- Message ErrorMessage
FileSystemSize
- FileSystemSize
object
: 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. Note that the value does not 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, the value will represent the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.- Timestamp Timestamp
- Value required FileSystemSizeValue
FileSystemSizeValue
- FileSystemSizeValue
integer
IncorrectFileSystemLifeCycleState
- IncorrectFileSystemLifeCycleState
object
: Returned if the file system's life cycle state is not "created".- ErrorCode required ErrorCode
- Message ErrorMessage
IncorrectMountTargetState
- IncorrectMountTargetState
object
: Returned if the mount target is not in the correct state for the operation.- ErrorCode required ErrorCode
- Message ErrorMessage
InternalServerError
- InternalServerError
object
: Returned if an error occurred on the server side.- ErrorCode required ErrorCode
- Message ErrorMessage
IpAddress
- IpAddress
string
IpAddressInUse
- IpAddressInUse
object
: Returned if the request specified an IpAddress that is already in use in the subnet.- ErrorCode required ErrorCode
- Message ErrorMessage
KmsKeyId
- KmsKeyId
string
LifeCycleState
- LifeCycleState
string
(values: creating, available, deleting, deleted)
Marker
- Marker
string
MaxItems
- MaxItems
integer
ModifyMountTargetSecurityGroupsRequest
- ModifyMountTargetSecurityGroupsRequest
object
:- SecurityGroups SecurityGroups
MountTargetConflict
- MountTargetConflict
object
: Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.- ErrorCode required ErrorCode
- Message ErrorMessage
MountTargetCount
- MountTargetCount
integer
MountTargetDescription
- MountTargetDescription
object
: Provides a description of a mount target.- FileSystemId required FileSystemId
- IpAddress IpAddress
- LifeCycleState required LifeCycleState
- MountTargetId required MountTargetId
- NetworkInterfaceId NetworkInterfaceId
- OwnerId AwsAccountId
- SubnetId required SubnetId
MountTargetDescriptions
- MountTargetDescriptions
array
- items MountTargetDescription
MountTargetId
- MountTargetId
string
MountTargetNotFound
- MountTargetNotFound
object
: Returned if there is no mount target with the specified ID found in the caller's account.- ErrorCode required ErrorCode
- Message ErrorMessage
NetworkInterfaceId
- NetworkInterfaceId
string
NetworkInterfaceLimitExceeded
- NetworkInterfaceLimitExceeded
object
: The calling account has reached the ENI limit for the specific AWS region. Client should try to delete some ENIs or get its account limit raised. For more information, see Amazon VPC Limits in the Amazon Virtual Private Cloud User Guide (see the Network interfaces per VPC entry in the table).- ErrorCode required ErrorCode
- Message ErrorMessage
NoFreeAddressesInSubnet
- NoFreeAddressesInSubnet
object
: Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.- ErrorCode required ErrorCode
- Message ErrorMessage
PerformanceMode
- PerformanceMode
string
(values: generalPurpose, maxIO)
SecurityGroup
- SecurityGroup
string
SecurityGroupLimitExceeded
- SecurityGroupLimitExceeded
object
: Returned if the size of SecurityGroups specified in the request is greater than five.- ErrorCode required ErrorCode
- Message ErrorMessage
SecurityGroupNotFound
- SecurityGroupNotFound
object
: Returned if one of the specified security groups does not exist in the subnet's VPC.- ErrorCode required ErrorCode
- Message ErrorMessage
SecurityGroups
- SecurityGroups
array
- items SecurityGroup
SubnetId
- SubnetId
string
SubnetNotFound
- SubnetNotFound
object
: Returned if there is no subnet with ID SubnetId provided in the request.- ErrorCode required ErrorCode
- Message ErrorMessage
Tag
- Tag
object
: A tag is a key-value pair. Allowed characters: letters, whitespace, and numbers, representable in UTF-8, and the following characters: + - = . _ : /
TagKey
- TagKey
string
TagKeys
- TagKeys
array
- items TagKey
TagValue
- TagValue
string
Tags
- Tags
array
- items Tag
Timestamp
- Timestamp
string
UnsupportedAvailabilityZone
- UnsupportedAvailabilityZone
object
:- ErrorCode required ErrorCode
- Message ErrorMessage