You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.EFS

Inherits:
AWS.Service show all
Identifier:
efs
API Version:
2015-02-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 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 Amazon Elastic File System API Reference and the Amazon Elastic File System User Guide.

Sending a Request Using EFS

var efs = new AWS.EFS();
efs.createMountTarget(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the EFS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var efs = new AWS.EFS({apiVersion: '2015-02-01'});

You can also set the API version globally in AWS.config.apiVersions using the efs service identifier:

AWS.config.apiVersions = {
  efs: '2015-02-01',
  // other service API versions
};

var efs = new AWS.EFS();

Version:

  • 2015-02-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.EFS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a EFS object

var efs = new AWS.EFS({apiVersion: '2015-02-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.EFS.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.EFS.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.EFS.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createAccessPoint(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createAccessPoint operation

var params = {
  ClientToken: 'STRING_VALUE', /* required */
  FileSystemId: 'STRING_VALUE', /* required */
  PosixUser: {
    Gid: 'NUMBER_VALUE', /* required */
    Uid: 'NUMBER_VALUE', /* required */
    SecondaryGids: [
      'NUMBER_VALUE',
      /* more items */
    ]
  },
  RootDirectory: {
    CreationInfo: {
      OwnerGid: 'NUMBER_VALUE', /* required */
      OwnerUid: 'NUMBER_VALUE', /* required */
      Permissions: 'STRING_VALUE' /* required */
    },
    Path: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
efs.createAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientToken — (String)

      A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      Creates tags associated with the access point. Each tag is a key-value pair, each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

      • Keyrequired — (String)

        The tag key (String). The key can't start with aws:.

      • Valuerequired — (String)

        The value of the tag key.

    • FileSystemId — (String)

      The ID of the EFS file system that the access point provides access to.

    • PosixUser — (map)

      The operating system user and group applied to all file system requests made using the access point.

      • Uidrequired — (Integer)

        The POSIX user ID used for all file system operations using this access point.

      • Gidrequired — (Integer)

        The POSIX group ID used for all file system operations using this access point.

      • SecondaryGids — (Array<Integer>)

        Secondary POSIX group IDs used for all file system operations using this access point.

    • RootDirectory — (map)

      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 > 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.

      Amazon EFS creates a root directory only if you have provided the CreationInfo: OwnUid, OwnGID, and permissions for the directory. If you do not provide this information, Amazon EFS does not create the root directory. If the root directory does not exist, attempts to mount using the access point will fail.

      • Path — (String)

        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.

      • CreationInfo — (map)

        (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > 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 > Path does not exist, attempts to mount the file system using the access point will fail.

        • OwnerUidrequired — (Integer)

          Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 232 (4294967295).

        • OwnerGidrequired — (Integer)

          Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 232 (4294967295).

        • Permissionsrequired — (String)

          Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClientToken — (String)

        The opaque string specified in the request to ensure idempotent creation.

      • Name — (String)

        The name of the access point. This is the value of the Name tag.

      • Tags — (Array<map>)

        The tags associated with the access point, presented as an array of Tag objects.

        • Keyrequired — (String)

          The tag key (String). The key can't start with aws:.

        • Valuerequired — (String)

          The value of the tag key.

      • AccessPointId — (String)

        The ID of the access point, assigned by Amazon EFS.

      • AccessPointArn — (String)

        The unique Amazon Resource Name (ARN) associated with the access point.

      • FileSystemId — (String)

        The ID of the EFS file system that the access point applies to.

      • PosixUser — (map)

        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.

        • Uidrequired — (Integer)

          The POSIX user ID used for all file system operations using this access point.

        • Gidrequired — (Integer)

          The POSIX group ID used for all file system operations using this access point.

        • SecondaryGids — (Array<Integer>)

          Secondary POSIX group IDs used for all file system operations using this access point.

      • RootDirectory — (map)

        The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

        • Path — (String)

          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.

        • CreationInfo — (map)

          (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > 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 > Path does not exist, attempts to mount the file system using the access point will fail.

          • OwnerUidrequired — (Integer)

            Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 232 (4294967295).

          • OwnerGidrequired — (Integer)

            Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 232 (4294967295).

          • Permissionsrequired — (String)

            Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

      • OwnerId — (String)

        Identified the Amazon Web Services account that owns the access point resource.

      • LifeCycleState — (String)

        Identifies the lifecycle phase of the access point.

        Possible values include:
        • "creating"
        • "available"
        • "updating"
        • "deleting"
        • "deleted"
        • "error"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createFileSystem(params = {}, callback) ⇒ AWS.Request

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 Amazon Web Services 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.

Note: 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.

For more information, see Creating a file system in the Amazon EFS User Guide.

Note: 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 accepts 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.

You can set the throughput mode for the file system using the ThroughputMode parameter.

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.

Service Reference:

Examples:

To create a new file system


/* This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode. */

 var params = {
  Backup: true, 
  CreationToken: "tokenstring", 
  Encrypted: true, 
  PerformanceMode: "generalPurpose", 
  Tags: [
     {
    Key: "Name", 
    Value: "MyFileSystem"
   }
  ]
 };
 efs.createFileSystem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    CreationTime: <Date Representation>, 
    CreationToken: "tokenstring", 
    Encrypted: true, 
    FileSystemId: "fs-01234567", 
    LifeCycleState: "creating", 
    NumberOfMountTargets: 0, 
    OwnerId: "012345678912", 
    PerformanceMode: "generalPurpose", 
    SizeInBytes: {
     Value: 0
    }, 
    Tags: [
       {
      Key: "Name", 
      Value: "MyFileSystem"
     }
    ]
   }
   */
 });

Calling the createFileSystem operation

var params = {
  CreationToken: 'STRING_VALUE', /* required */
  AvailabilityZoneName: 'STRING_VALUE',
  Backup: true || false,
  Encrypted: true || false,
  KmsKeyId: 'STRING_VALUE',
  PerformanceMode: generalPurpose | maxIO,
  ProvisionedThroughputInMibps: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  ThroughputMode: bursting | provisioned
};
efs.createFileSystem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • CreationToken — (String)

      A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

      If a token is not provided, the SDK will use a version 4 UUID.
    • PerformanceMode — (String)

      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.

      Note: The maxIO mode is not supported on file systems using One Zone storage classes.
      Possible values include:
      • "generalPurpose"
      • "maxIO"
    • Encrypted — (Boolean)

      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 Key Management Service (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.

    • KmsKeyId — (String)

      The ID of the KMS CMK that you want to use to protect the encrypted file system. This parameter is only required if you want to use a non-default KMS key. 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 KMS keys. You cannot use asymmetric KMS keys with EFS file systems.

    • ThroughputMode — (String)

      Specifies the throughput mode for the file system, either bursting or provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps. After you create the file system, 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 information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.

      Default is bursting.

      Possible values include:
      • "bursting"
      • "provisioned"
    • ProvisionedThroughputInMibps — (Float)

      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. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide.

    • AvailabilityZoneName — (String)

      Used to create a file system that uses One Zone storage classes. It specifies the Amazon Web Services Availability Zone in which to create the file system. Use the format us-east-1a to specify the Availability Zone. For more information about One Zone storage classes, see Using EFS storage classes in the Amazon EFS User Guide.

      Note: One Zone storage classes are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available.
    • Backup — (Boolean)

      Specifies whether automatic backups are enabled on the file system that you are creating. Set the value to true to enable automatic backups. If you are creating a file system that uses One Zone storage classes, automatic backups are enabled by default. For more information, see Automatic backups in the Amazon EFS User Guide.

      Default is false. However, if you specify an AvailabilityZoneName, the default is true.

      Note: Backup is not available in all Amazon Web Services Regionswhere Amazon EFS is available.
    • Tags — (Array<map>)

      Use 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. Each key must be unique. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

      • Keyrequired — (String)

        The tag key (String). The key can't start with aws:.

      • Valuerequired — (String)

        The value of the tag key.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OwnerId — (String)

        The Amazon Web Services 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.

      • CreationToken — (String)

        The opaque string specified in the request.

      • FileSystemId — (String)

        The ID of the file system, assigned by Amazon EFS.

      • FileSystemArn — (String)

        The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

      • CreationTime — (Date)

        The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

      • LifeCycleState — (String)

        The lifecycle phase of the file system.

        Possible values include:
        • "creating"
        • "available"
        • "updating"
        • "deleting"
        • "deleted"
        • "error"
      • Name — (String)

        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.

      • NumberOfMountTargets — (Integer)

        The current number of mount targets that the file system has. For more information, see CreateMountTarget.

      • SizeInBytes — (map)

        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.

        • Valuerequired — (Integer)

          The latest known metered size (in bytes) of data stored in the file system.

        • Timestamp — (Date)

          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.

        • ValueInIA — (Integer)

          The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

        • ValueInStandard — (Integer)

          The latest known metered size (in bytes) of data stored in the Standard storage class.

      • PerformanceMode — (String)

        The performance mode of the file system.

        Possible values include:
        • "generalPurpose"
        • "maxIO"
      • Encrypted — (Boolean)

        A Boolean value that, if true, indicates that the file system is encrypted.

      • KmsKeyId — (String)

        The ID of an Key Management Service customer master key (CMK) that was used to protect the encrypted file system.

      • ThroughputMode — (String)

        Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

        Possible values include:
        • "bursting"
        • "provisioned"
      • ProvisionedThroughputInMibps — (Float)

        The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

      • AvailabilityZoneName — (String)

        Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.

      • AvailabilityZoneId — (String)

        The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

      • Tags — (Array<map>)

        The tags associated with the file system, presented as an array of Tag objects.

        • Keyrequired — (String)

          The tag key (String). The key can't start with aws:.

        • Valuerequired — (String)

          The value of the tag key.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createMountTarget(params = {}, callback) ⇒ AWS.Request

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.

You can create only one mount target for an EFS file system using One Zone storage classes. You must create that mount target in the same Availability Zone in which the file system is located. Use the AvailabilityZoneName and AvailabiltyZoneId properties in the DescribeFileSystems response object to get this information. Use the subnetId associated with the file system's Availability Zone when creating the mount target.

For more information, see Amazon EFS: How it Works.

To create a mount target for a file system, the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, provide the following:

  • The file system ID for which you are creating the mount target.

  • A subnet ID, which determines the following:

    • The VPC in which Amazon EFS creates the mount target

    • The Availability Zone in which Amazon EFS creates the mount target

    • The 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.

Note: 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

Service Reference:

Examples:

To create a new mount target


/* This operation creates a new mount target for an EFS file system. */

 var params = {
  FileSystemId: "fs-01234567", 
  SubnetId: "subnet-1234abcd"
 };
 efs.createMountTarget(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FileSystemId: "fs-01234567", 
    IpAddress: "192.0.0.2", 
    LifeCycleState: "creating", 
    MountTargetId: "fsmt-12340abc", 
    NetworkInterfaceId: "eni-cedf6789", 
    OwnerId: "012345678912", 
    SubnetId: "subnet-1234abcd"
   }
   */
 });

Calling the createMountTarget operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  SubnetId: 'STRING_VALUE', /* required */
  IpAddress: 'STRING_VALUE',
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ]
};
efs.createMountTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system for which to create the mount target.

    • SubnetId — (String)

      The ID of the subnet to add the mount target in. For file systems that use One Zone storage classes, use the subnet that is associated with the file system's Availability Zone.

    • IpAddress — (String)

      Valid IPv4 address within the address range of the specified subnet.

    • SecurityGroups — (Array<String>)

      Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OwnerId — (String)

        Amazon Web Services account ID that owns the resource.

      • MountTargetId — (String)

        System-assigned mount target ID.

      • FileSystemId — (String)

        The ID of the file system for which the mount target is intended.

      • SubnetId — (String)

        The ID of the mount target's subnet.

      • LifeCycleState — (String)

        Lifecycle state of the mount target.

        Possible values include:
        • "creating"
        • "available"
        • "updating"
        • "deleting"
        • "deleted"
        • "error"
      • IpAddress — (String)

        Address at which the file system can be mounted by using the mount target.

      • NetworkInterfaceId — (String)

        The ID of the network interface that Amazon EFS created when it created the mount target.

      • AvailabilityZoneId — (String)

        The unique and consistent identifier of the Availability Zone 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 Amazon Web Services account.

      • AvailabilityZoneName — (String)

        The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon Web Services account.

      • VpcId — (String)

        The virtual private cloud (VPC) ID that the mount target is configured in.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createTags(params = {}, callback) ⇒ AWS.Request

Note: DEPRECATED - CreateTags is deprecated and not maintained. Please use the API action to create tags for EFS resources.

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.

Service Reference:

Examples:

To create a new tag


/* This operation creates a new tag for an EFS file system. */

 var params = {
  FileSystemId: "fs-01234567", 
  Tags: [
     {
    Key: "Name", 
    Value: "MyFileSystem"
   }
  ]
 };
 efs.createTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the createTags operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
efs.createTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.

    • Tags — (Array<map>)

      An array of Tag objects to add. Each Tag object is a key-value pair.

      • Keyrequired — (String)

        The tag key (String). The key can't start with aws:.

      • Valuerequired — (String)

        The value of the tag key.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAccessPoint(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteAccessPoint operation

var params = {
  AccessPointId: 'STRING_VALUE' /* required */
};
efs.deleteAccessPoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • AccessPointId — (String)

      The ID of the access point that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFileSystem(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

Service Reference:

Examples:

To delete a file system


/* This operation deletes an EFS file system. */

 var params = {
  FileSystemId: "fs-01234567"
 };
 efs.deleteFileSystem(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteFileSystem operation

var params = {
  FileSystemId: 'STRING_VALUE' /* required */
};
efs.deleteFileSystem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFileSystemPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deleteFileSystemPolicy operation

var params = {
  FileSystemId: 'STRING_VALUE' /* required */
};
efs.deleteFileSystemPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      Specifies the EFS file system for which to delete the FileSystemPolicy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMountTarget(params = {}, callback) ⇒ AWS.Request

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

Note: 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

Service Reference:

Examples:

To delete a mount target


/* This operation deletes a mount target. */

 var params = {
  MountTargetId: "fsmt-12340abc"
 };
 efs.deleteMountTarget(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteMountTarget operation

var params = {
  MountTargetId: 'STRING_VALUE' /* required */
};
efs.deleteMountTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MountTargetId — (String)

      The ID of the mount target to delete (String).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteTags(params = {}, callback) ⇒ AWS.Request

Note: DEPRECATED - DeleteTags is deprecated and not maintained. Please use the API action to remove tags from EFS resources.

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 Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

Service Reference:

Examples:

To delete tags for an EFS file system


/* This operation deletes tags for an EFS file system. */

 var params = {
  FileSystemId: "fs-01234567", 
  TagKeys: [
     "Name"
  ]
 };
 efs.deleteTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the deleteTags operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
efs.deleteTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system whose tags you want to delete (String).

    • TagKeys — (Array<String>)

      A list of tag keys to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAccessPoints(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeAccessPoints operation

var params = {
  AccessPointId: 'STRING_VALUE',
  FileSystemId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
efs.describeAccessPoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      (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.

    • NextToken — (String)

      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.

    • AccessPointId — (String)

      (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with FileSystemId.

    • FileSystemId — (String)

      (Optional) If you provide a FileSystemId, EFS returns all access points for that file system; mutually exclusive with AccessPointId.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccessPoints — (Array<map>)

        An array of access point descriptions.

        • ClientToken — (String)

          The opaque string specified in the request to ensure idempotent creation.

        • Name — (String)

          The name of the access point. This is the value of the Name tag.

        • Tags — (Array<map>)

          The tags associated with the access point, presented as an array of Tag objects.

          • Keyrequired — (String)

            The tag key (String). The key can't start with aws:.

          • Valuerequired — (String)

            The value of the tag key.

        • AccessPointId — (String)

          The ID of the access point, assigned by Amazon EFS.

        • AccessPointArn — (String)

          The unique Amazon Resource Name (ARN) associated with the access point.

        • FileSystemId — (String)

          The ID of the EFS file system that the access point applies to.

        • PosixUser — (map)

          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.

          • Uidrequired — (Integer)

            The POSIX user ID used for all file system operations using this access point.

          • Gidrequired — (Integer)

            The POSIX group ID used for all file system operations using this access point.

          • SecondaryGids — (Array<Integer>)

            Secondary POSIX group IDs used for all file system operations using this access point.

        • RootDirectory — (map)

          The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.

          • Path — (String)

            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.

          • CreationInfo — (map)

            (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If the RootDirectory > 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 > Path does not exist, attempts to mount the file system using the access point will fail.

            • OwnerUidrequired — (Integer)

              Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 232 (4294967295).

            • OwnerGidrequired — (Integer)

              Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 232 (4294967295).

            • Permissionsrequired — (String)

              Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number representing the file's mode bits.

        • OwnerId — (String)

          Identified the Amazon Web Services account that owns the access point resource.

        • LifeCycleState — (String)

          Identifies the lifecycle phase of the access point.

          Possible values include:
          • "creating"
          • "available"
          • "updating"
          • "deleting"
          • "deleted"
          • "error"
      • NextToken — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeAccountPreferences(params = {}, callback) ⇒ AWS.Request

Returns the account preferences settings for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region. For more information, see Managing Amazon EFS resource IDs.

Service Reference:

Examples:

Calling the describeAccountPreferences operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
efs.describeAccountPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextToken — (String)

      (Optional) You can use NextToken in a subsequent request to fetch the next page of Amazon Web Services account preferences if the response payload was paginated.

    • MaxResults — (Integer)

      (Optional) When retrieving account preferences, you can optionally specify the MaxItems parameter to limit the number of objects returned in a response. The default value is 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceIdPreference — (map)

        Describes the resource ID preference setting for the Amazon Web Services account associated with the user making the request, in the current Amazon Web Services Region.

        • ResourceIdType — (String)

          Identifies the EFS resource ID preference, either LONG_ID (17 characters) or SHORT_ID (8 characters).

          Possible values include:
          • "LONG_ID"
          • "SHORT_ID"
        • Resources — (Array<String>)

          Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and MOUNT_TARGET.

      • NextToken — (String)

        Present if there are more records than returned in the response. You can use the NextToken in the subsequent request to fetch the additional descriptions.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeBackupPolicy(params = {}, callback) ⇒ AWS.Request

Returns the backup policy for the specified EFS file system.

Service Reference:

Examples:

Calling the describeBackupPolicy operation

var params = {
  FileSystemId: 'STRING_VALUE' /* required */
};
efs.describeBackupPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      Specifies which EFS file system to retrieve the BackupPolicy for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPolicy — (map)

        Describes the file system's backup policy, indicating whether automatic backups are turned on or off..

        • Statusrequired — (String)

          Describes the status of the file system's backup policy.

          • ENABLED - EFS is automatically backing up the file system.

          • ENABLING - EFS is turning on automatic backups for the file system.

          • DISABLED - automatic back ups are turned off for the file system.

          • DISABLING - EFS is turning off automatic backups for the file system.

          Possible values include:
          • "ENABLED"
          • "ENABLING"
          • "DISABLED"
          • "DISABLING"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFileSystemPolicy(params = {}, callback) ⇒ AWS.Request

Returns the FileSystemPolicy for the specified EFS file system.

This operation requires permissions for the elasticfilesystem:DescribeFileSystemPolicy action.

Service Reference:

Examples:

Calling the describeFileSystemPolicy operation

var params = {
  FileSystemId: 'STRING_VALUE' /* required */
};
efs.describeFileSystemPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      Specifies which EFS file system to retrieve the FileSystemPolicy for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FileSystemId — (String)

        Specifies the EFS file system to which the FileSystemPolicy applies.

      • Policy — (String)

        The JSON formatted FileSystemPolicy for the EFS file system.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeFileSystems(params = {}, callback) ⇒ AWS.Request

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 Amazon Web Services account in the Amazon Web Services 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.

Service Reference:

Examples:

To describe an EFS file system


/* This operation describes all of the EFS file systems in an account. */

 var params = {
 };
 efs.describeFileSystems(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    FileSystems: [
       {
      CreationTime: <Date Representation>, 
      CreationToken: "tokenstring", 
      FileSystemId: "fs-01234567", 
      LifeCycleState: "available", 
      Name: "MyFileSystem", 
      NumberOfMountTargets: 1, 
      OwnerId: "012345678912", 
      PerformanceMode: "generalPurpose", 
      SizeInBytes: {
       Value: 6144
      }, 
      Tags: [
         {
        Key: "Name", 
        Value: "MyFileSystem"
       }
      ]
     }
    ]
   }
   */
 });

Calling the describeFileSystems operation

var params = {
  CreationToken: 'STRING_VALUE',
  FileSystemId: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxItems: 'NUMBER_VALUE'
};
efs.describeFileSystems(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxItems — (Integer)

      (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.

    • Marker — (String)

      (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.

    • CreationToken — (String)

      (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.

    • FileSystemId — (String)

      (Optional) ID of the file system whose description you want to retrieve (String).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        Present if provided by caller in the request (String).

      • FileSystems — (Array<map>)

        An array of file system descriptions.

        • OwnerIdrequired — (String)

          The Amazon Web Services 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.

        • CreationTokenrequired — (String)

          The opaque string specified in the request.

        • FileSystemIdrequired — (String)

          The ID of the file system, assigned by Amazon EFS.

        • FileSystemArn — (String)

          The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

        • CreationTimerequired — (Date)

          The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

        • LifeCycleStaterequired — (String)

          The lifecycle phase of the file system.

          Possible values include:
          • "creating"
          • "available"
          • "updating"
          • "deleting"
          • "deleted"
          • "error"
        • Name — (String)

          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.

        • NumberOfMountTargetsrequired — (Integer)

          The current number of mount targets that the file system has. For more information, see CreateMountTarget.

        • SizeInBytesrequired — (map)

          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.

          • Valuerequired — (Integer)

            The latest known metered size (in bytes) of data stored in the file system.

          • Timestamp — (Date)

            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.

          • ValueInIA — (Integer)

            The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

          • ValueInStandard — (Integer)

            The latest known metered size (in bytes) of data stored in the Standard storage class.

        • PerformanceModerequired — (String)

          The performance mode of the file system.

          Possible values include:
          • "generalPurpose"
          • "maxIO"
        • Encrypted — (Boolean)

          A Boolean value that, if true, indicates that the file system is encrypted.

        • KmsKeyId — (String)

          The ID of an Key Management Service customer master key (CMK) that was used to protect the encrypted file system.

        • ThroughputMode — (String)

          Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

          Possible values include:
          • "bursting"
          • "provisioned"
        • ProvisionedThroughputInMibps — (Float)

          The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

        • AvailabilityZoneName — (String)

          Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.

        • AvailabilityZoneId — (String)

          The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

        • Tagsrequired — (Array<map>)

          The tags associated with the file system, presented as an array of Tag objects.

          • Keyrequired — (String)

            The tag key (String). The key can't start with aws:.

          • Valuerequired — (String)

            The value of the tag key.

      • NextMarker — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request

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.

When EFS Intelligent Tiering is enabled, TransitionToPrimaryStorageClass has a value of AFTER_1_ACCESS.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

Service Reference:

Examples:

To describe the lifecycle configuration for a file system


/* This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class.  */

 var params = {
  FileSystemId: "fs-01234567"
 };
 efs.describeLifecycleConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LifecyclePolicies: [
       {
      TransitionToIA: "AFTER_30_DAYS"
     }
    ]
   }
   */
 });

Calling the describeLifecycleConfiguration operation

var params = {
  FileSystemId: 'STRING_VALUE' /* required */
};
efs.describeLifecycleConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LifecyclePolicies — (Array<map>)

        An array of lifecycle management policies. EFS supports a maximum of one policy per file system.

        • TransitionToIA — (String)

          Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.

          Possible values include:
          • "AFTER_7_DAYS"
          • "AFTER_14_DAYS"
          • "AFTER_30_DAYS"
          • "AFTER_60_DAYS"
          • "AFTER_90_DAYS"
        • TransitionToPrimaryStorageClass — (String)

          Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.

          Possible values include:
          • "AFTER_1_ACCESS"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeMountTargets(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To describe the mount targets for a file system


/* This operation describes all of a file system's mount targets. */

 var params = {
  FileSystemId: "fs-01234567"
 };
 efs.describeMountTargets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    MountTargets: [
       {
      FileSystemId: "fs-01234567", 
      IpAddress: "192.0.0.2", 
      LifeCycleState: "available", 
      MountTargetId: "fsmt-12340abc", 
      NetworkInterfaceId: "eni-cedf6789", 
      OwnerId: "012345678912", 
      SubnetId: "subnet-1234abcd"
     }
    ]
   }
   */
 });

Calling the describeMountTargets operation

var params = {
  AccessPointId: 'STRING_VALUE',
  FileSystemId: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxItems: 'NUMBER_VALUE',
  MountTargetId: 'STRING_VALUE'
};
efs.describeMountTargets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxItems — (Integer)

      (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.

    • Marker — (String)

      (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.

    • FileSystemId — (String)

      (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.

    • MountTargetId — (String)

      (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.

    • AccessPointId — (String)

      (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        If the request included the Marker, the response returns that value in this field.

      • MountTargets — (Array<map>)

        Returns the file system's mount targets as an array of MountTargetDescription objects.

        • OwnerId — (String)

          Amazon Web Services account ID that owns the resource.

        • MountTargetIdrequired — (String)

          System-assigned mount target ID.

        • FileSystemIdrequired — (String)

          The ID of the file system for which the mount target is intended.

        • SubnetIdrequired — (String)

          The ID of the mount target's subnet.

        • LifeCycleStaterequired — (String)

          Lifecycle state of the mount target.

          Possible values include:
          • "creating"
          • "available"
          • "updating"
          • "deleting"
          • "deleted"
          • "error"
        • IpAddress — (String)

          Address at which the file system can be mounted by using the mount target.

        • NetworkInterfaceId — (String)

          The ID of the network interface that Amazon EFS created when it created the mount target.

        • AvailabilityZoneId — (String)

          The unique and consistent identifier of the Availability Zone 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 Amazon Web Services account.

        • AvailabilityZoneName — (String)

          The name of the Availability Zone in which the mount target is located. Availability Zones are independently mapped to names for each Amazon Web Services account. For example, the Availability Zone us-east-1a for your Amazon Web Services account might not be the same location as us-east-1a for another Amazon Web Services account.

        • VpcId — (String)

          The virtual private cloud (VPC) ID that the mount target is configured in.

      • NextMarker — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeMountTargetSecurityGroups(params = {}, callback) ⇒ AWS.Request

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.

Examples:

To describe the security groups for a mount target


/* This operation describes all of the security groups for a file system's mount target. */

 var params = {
  MountTargetId: "fsmt-12340abc"
 };
 efs.describeMountTargetSecurityGroups(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SecurityGroups: [
       "sg-4567abcd"
    ]
   }
   */
 });

Calling the describeMountTargetSecurityGroups operation

var params = {
  MountTargetId: 'STRING_VALUE' /* required */
};
efs.describeMountTargetSecurityGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MountTargetId — (String)

      The ID of the mount target whose security groups you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroups — (Array<String>)

        An array of security groups.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeTags(params = {}, callback) ⇒ AWS.Request

Note: DEPRECATED - The DeleteTags action is deprecated and not maintained. Please use the API action to remove tags from EFS resources.

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.

Service Reference:

Examples:

To describe the tags for a file system


/* This operation describes all of a file system's tags. */

 var params = {
  FileSystemId: "fs-01234567"
 };
 efs.describeTags(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Tags: [
       {
      Key: "Name", 
      Value: "MyFileSystem"
     }
    ]
   }
   */
 });

Calling the describeTags operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxItems: 'NUMBER_VALUE'
};
efs.describeTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxItems — (Integer)

      (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.

    • Marker — (String)

      (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.

    • FileSystemId — (String)

      The ID of the file system whose tag set you want to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        If the request included a Marker, the response returns that value in this field.

      • Tags — (Array<map>)

        Returns tags associated with the file system as an array of Tag objects.

        • Keyrequired — (String)

          The tag key (String). The key can't start with aws:.

        • Valuerequired — (String)

          The value of the tag key.

      • NextMarker — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
efs.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceId — (String)

      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.

    • MaxResults — (Integer)

      (Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.

    • NextToken — (String)

      (Optional) You can use NextToken in a subsequent request to fetch the next page of access point descriptions if the response payload was paginated.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (Array<map>)

        An array of the tags for the specified EFS resource.

        • Keyrequired — (String)

          The tag key (String). The key can't start with aws:.

        • Valuerequired — (String)

          The value of the tag key.

      • NextToken — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

modifyMountTargetSecurityGroups(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

To modify the security groups associated with a mount target for a file system


/* This operation modifies the security groups associated with a mount target for a file system. */

 var params = {
  MountTargetId: "fsmt-12340abc", 
  SecurityGroups: [
     "sg-abcd1234"
  ]
 };
 efs.modifyMountTargetSecurityGroups(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
 });

Calling the modifyMountTargetSecurityGroups operation

var params = {
  MountTargetId: 'STRING_VALUE', /* required */
  SecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ]
};
efs.modifyMountTargetSecurityGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MountTargetId — (String)

      The ID of the mount target whose security groups you want to modify.

    • SecurityGroups — (Array<String>)

      An array of up to five VPC security group IDs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putAccountPreferences(params = {}, callback) ⇒ AWS.Request

Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the opt-in period as EFS transitions to long resource IDs. For more information, see Managing Amazon EFS resource IDs.

Note: 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.

Service Reference:

Examples:

Calling the putAccountPreferences operation

var params = {
  ResourceIdType: LONG_ID | SHORT_ID /* required */
};
efs.putAccountPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceIdType — (String)

      Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, either LONG_ID (17 characters), or SHORT_ID (8 characters).

      Note: Starting in October, 2021, you will receive an error when setting the account preference to SHORT_ID. Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.
      Possible values include:
      • "LONG_ID"
      • "SHORT_ID"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceIdPreference — (map)

        Describes the resource type and its ID preference for the user's Amazon Web Services account, in the current Amazon Web Services Region.

        • ResourceIdType — (String)

          Identifies the EFS resource ID preference, either LONG_ID (17 characters) or SHORT_ID (8 characters).

          Possible values include:
          • "LONG_ID"
          • "SHORT_ID"
        • Resources — (Array<String>)

          Identifies the Amazon EFS resources to which the ID preference setting applies, FILE_SYSTEM and MOUNT_TARGET.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putBackupPolicy(params = {}, callback) ⇒ AWS.Request

Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

Service Reference:

Examples:

Calling the putBackupPolicy operation

var params = {
  BackupPolicy: { /* required */
    Status: ENABLED | ENABLING | DISABLED | DISABLING /* required */
  },
  FileSystemId: 'STRING_VALUE' /* required */
};
efs.putBackupPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      Specifies which EFS file system to update the backup policy for.

    • BackupPolicy — (map)

      The backup policy included in the PutBackupPolicy request.

      • Statusrequired — (String)

        Describes the status of the file system's backup policy.

        • ENABLED - EFS is automatically backing up the file system.

        • ENABLING - EFS is turning on automatic backups for the file system.

        • DISABLED - automatic back ups are turned off for the file system.

        • DISABLING - EFS is turning off automatic backups for the file system.

        Possible values include:
        • "ENABLED"
        • "ENABLING"
        • "DISABLED"
        • "DISABLING"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • BackupPolicy — (map)

        Describes the file system's backup policy, indicating whether automatic backups are turned on or off..

        • Statusrequired — (String)

          Describes the status of the file system's backup policy.

          • ENABLED - EFS is automatically backing up the file system.

          • ENABLING - EFS is turning on automatic backups for the file system.

          • DISABLED - automatic back ups are turned off for the file system.

          • DISABLING - EFS is turning off automatic backups for the file system.

          Possible values include:
          • "ENABLED"
          • "ENABLING"
          • "DISABLED"
          • "DISABLING"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putFileSystemPolicy(params = {}, callback) ⇒ AWS.Request

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. EFS file system policies have a 20,000 character limit. 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.

Note: EFS file system policies have a 20,000 character limit.

This operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.

Service Reference:

Examples:

Calling the putFileSystemPolicy operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE', /* required */
  BypassPolicyLockoutSafetyCheck: true || false
};
efs.putFileSystemPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the EFS file system that you want to create or update the FileSystemPolicy for.

    • Policy — (String)

      The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. EFS file system policies have a 20,000 character limit. To find out more about the elements that make up a file system policy, see EFS Resource-based Policies.

    • BypassPolicyLockoutSafetyCheck — (Boolean)

      (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • FileSystemId — (String)

        Specifies the EFS file system to which the FileSystemPolicy applies.

      • Policy — (String)

        The JSON formatted FileSystemPolicy for the EFS file system.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putLifecycleConfiguration(params = {}, callback) ⇒ AWS.Request

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. To enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS. For more information, see EFS Lifecycle Management.

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 turns off lifecycle management for the file system.

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. Amazon EFS requires that each LifecyclePolicy object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate LifecyclePolicy objects. See the example requests in the following section for more information.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same Key Management Service permissions as when you created the encrypted file system.

Service Reference:

Examples:

Creates a new lifecycleconfiguration object for a file system


/* This operation enables lifecycle management on a file system 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. */

 var params = {
  FileSystemId: "fs-01234567", 
  LifecyclePolicies: [
     {
    TransitionToIA: "AFTER_30_DAYS"
   }
  ]
 };
 efs.putLifecycleConfiguration(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    LifecyclePolicies: [
       {
      TransitionToIA: "AFTER_30_DAYS"
     }
    ]
   }
   */
 });

Calling the putLifecycleConfiguration operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  LifecyclePolicies: [ /* required */
    {
      TransitionToIA: AFTER_7_DAYS | AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_90_DAYS,
      TransitionToPrimaryStorageClass: AFTER_1_ACCESS
    },
    /* more items */
  ]
};
efs.putLifecycleConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system for which you are creating the LifecycleConfiguration object (String).

    • LifecyclePolicies — (Array<map>)

      An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS lifecycle management and intelligent tiering of the following:

      • When to move files in the file system from primary storage to the IA storage class.

      • When to move files that are in IA storage to primary storage.

      Note: When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToPrimaryStorageClass. See the example requests in the following section for more information.
      • TransitionToIA — (String)

        Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        Possible values include:
        • "AFTER_7_DAYS"
        • "AFTER_14_DAYS"
        • "AFTER_30_DAYS"
        • "AFTER_60_DAYS"
        • "AFTER_90_DAYS"
      • TransitionToPrimaryStorageClass — (String)

        Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        Possible values include:
        • "AFTER_1_ACCESS"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LifecyclePolicies — (Array<map>)

        An array of lifecycle management policies. EFS supports a maximum of one policy per file system.

        • TransitionToIA — (String)

          Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata operations such as listing the contents of a directory don't count as file access events.

          Possible values include:
          • "AFTER_7_DAYS"
          • "AFTER_14_DAYS"
          • "AFTER_30_DAYS"
          • "AFTER_60_DAYS"
          • "AFTER_90_DAYS"
        • TransitionToPrimaryStorageClass — (String)

          Describes when to transition a file from IA storage to primary storage. Metadata operations such as listing the contents of a directory don't count as file access events.

          Possible values include:
          • "AFTER_1_ACCESS"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
efs.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceId — (String)

      The ID specifying the EFS resource that you want to create a tag for.

    • Tags — (Array<map>)

      An array of Tag objects to add. Each Tag object is a key-value pair.

      • Keyrequired — (String)

        The tag key (String). The key can't start with aws:.

      • Valuerequired — (String)

        The value of the tag key.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
efs.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceId — (String)

      Specifies the EFS resource that you want to remove tags from.

    • TagKeys — (Array<String>)

      The keys of the key-value tag pairs that you want to remove from the specified EFS resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateFileSystem(params = {}, callback) ⇒ AWS.Request

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

Service Reference:

Examples:

Calling the updateFileSystem operation

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  ProvisionedThroughputInMibps: 'NUMBER_VALUE',
  ThroughputMode: bursting | provisioned
};
efs.updateFileSystem(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • FileSystemId — (String)

      The ID of the file system that you want to update.

    • ThroughputMode — (String)

      (Optional) Updates the file system's throughput mode. 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.

      Possible values include:
      • "bursting"
      • "provisioned"
    • ProvisionedThroughputInMibps — (Float)

      (Optional) Sets the amount of provisioned throughput, in MiB/s, for the file system. Valid values are 1-1024. If you are changing the throughput mode to provisioned, you must also provide the amount of provisioned throughput. Required if ThroughputMode is changed to provisioned on update.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OwnerId — (String)

        The Amazon Web Services 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.

      • CreationToken — (String)

        The opaque string specified in the request.

      • FileSystemId — (String)

        The ID of the file system, assigned by Amazon EFS.

      • FileSystemArn — (String)

        The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

      • CreationTime — (Date)

        The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

      • LifeCycleState — (String)

        The lifecycle phase of the file system.

        Possible values include:
        • "creating"
        • "available"
        • "updating"
        • "deleting"
        • "deleted"
        • "error"
      • Name — (String)

        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.

      • NumberOfMountTargets — (Integer)

        The current number of mount targets that the file system has. For more information, see CreateMountTarget.

      • SizeInBytes — (map)

        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.

        • Valuerequired — (Integer)

          The latest known metered size (in bytes) of data stored in the file system.

        • Timestamp — (Date)

          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.

        • ValueInIA — (Integer)

          The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

        • ValueInStandard — (Integer)

          The latest known metered size (in bytes) of data stored in the Standard storage class.

      • PerformanceMode — (String)

        The performance mode of the file system.

        Possible values include:
        • "generalPurpose"
        • "maxIO"
      • Encrypted — (Boolean)

        A Boolean value that, if true, indicates that the file system is encrypted.

      • KmsKeyId — (String)

        The ID of an Key Management Service customer master key (CMK) that was used to protect the encrypted file system.

      • ThroughputMode — (String)

        Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.

        Possible values include:
        • "bursting"
        • "provisioned"
      • ProvisionedThroughputInMibps — (Float)

        The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.

      • AvailabilityZoneName — (String)

        Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.

      • AvailabilityZoneId — (String)

        The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

      • Tags — (Array<map>)

        The tags associated with the file system, presented as an array of Tag objects.

        • Keyrequired — (String)

          The tag key (String). The key can't start with aws:.

        • Valuerequired — (String)

          The value of the tag key.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.