Class: AWS.EFS

/* 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"
     }
    ]
   }
   */
 });

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 | elastic
};
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 all 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. The maxIO mode is not supported on One Zone file systems.

    Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.

    Default is generalPurpose.

    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 an existing Key Management Service key (KMS key). If you don't specify a KMS key, then the default KMS key for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.

  • KmsKeyId — (String)

    The ID of the KMS key that you want to use to protect the encrypted file system. This parameter is required only if you want to use a non-default KMS key. If this parameter is not specified, the default KMS key for Amazon EFS is used. You can specify a KMS key ID using 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 you use KmsKeyId, you must set the CreateFileSystemRequest$Encrypted parameter to true.

    EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems.

  • ThroughputMode — (String)

    Specifies the throughput mode for the file system. The mode can be bursting, provisioned, or elastic. 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 Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see Specifying throughput with provisioned mode in the Amazon EFS User Guide.

    Default is bursting.

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

    The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on Region. 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 One Zone file system. 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 file systems, see Using EFS storage classes in the Amazon EFS User Guide.

    Note: One Zone file systems 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 One Zone file system, 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 Regions where 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.

    • Key — required — (String)

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

    • Value — required — (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.

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

      • Value — required — (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.

      • ValueInArchive — (Integer)

        The latest known metered size (in bytes) of data stored in the Archive 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 KMS key 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"
      • "elastic"
    • ProvisionedThroughputInMibps — (Float)

      The amount of provisioned throughput, measured in MiBps, 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 One Zone file systems. 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 is located, and is valid only for One Zone file systems. 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.

      • Key — required — (String)

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

      • Value — required — (String)

        The value of the tag key.

    • FileSystemProtection — (map)

      Describes the protection on the file system.

      • ReplicationOverwriteProtection — (String)

        The status of the file system's replication overwrite protection.

        • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

        • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

        • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

        If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
        • "REPLICATING"

Returns:

• (AWS.Request) —

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

/* 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"
   }
   */
 });

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 One Zone file systems, 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.

var params = {
  Destinations: [ /* required */
    {
      AvailabilityZoneName: 'STRING_VALUE',
      FileSystemId: 'STRING_VALUE',
      KmsKeyId: 'STRING_VALUE',
      Region: 'STRING_VALUE'
    },
    /* more items */
  ],
  SourceFileSystemId: 'STRING_VALUE' /* required */
};
efs.createReplicationConfiguration(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: {}) —
  • SourceFileSystemId — (String)

    Specifies the Amazon EFS file system that you want to replicate. This file system cannot already be a source or destination file system in another replication configuration.

  • Destinations — (Array<map>)

    An array of destination configuration objects. Only one destination configuration object is supported.

    • Region — (String)

      To create a file system that uses Regional storage, specify the Amazon Web Services Region in which to create the destination file system.

    • AvailabilityZoneName — (String)

      To create a file system that uses One Zone storage, specify the name of the Availability Zone in which to create the destination file system.

    • KmsKeyId — (String)

      Specify the Key Management Service (KMS) key that you want to use to encrypt the destination file system. If you do not specify a KMS key, Amazon EFS uses your default KMS key for Amazon EFS, /aws/elasticfilesystem. This ID can be in one of the following formats:

      • Key ID - The unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.

      • ARN - The 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 - The ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

    • FileSystemId — (String)

      The ID of the file system to use for the destination. The file system's replication overwrite replication must be disabled. If you do not provide an ID, then EFS creates a new file system for the replication destination.

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:

    • SourceFileSystemId — (String)

      The ID of the source Amazon EFS file system that is being replicated.

    • SourceFileSystemRegion — (String)

      The Amazon Web Services Region in which the source EFS file system is located.

    • SourceFileSystemArn — (String)

      The Amazon Resource Name (ARN) of the current source file system in the replication configuration.

    • OriginalSourceFileSystemArn — (String)

      The Amazon Resource Name (ARN) of the original source EFS file system in the replication configuration.

    • CreationTime — (Date)

      Describes when the replication configuration was created.

    • Destinations — (Array<map>)

      An array of destination objects. Only one destination object is supported.

      • Status — required — (String)

        Describes the status of the destination EFS file system.

        • The Paused state occurs as a result of opting out of the source or destination Region after the replication configuration was created. To resume replication for the file system, you need to again opt in to the Amazon Web Services Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Guide.

        • The Error state occurs when either the source or the destination file system (or both) is in a failed state and is unrecoverable. For more information, see Monitoring replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then restore the most recent backup of the failed file system (either the source or the destination) to a new file system.

        Possible values include:
        • "ENABLED"
        • "ENABLING"
        • "DELETING"
        • "ERROR"
        • "PAUSED"
        • "PAUSING"
      • FileSystemId — required — (String)

        The ID of the destination Amazon EFS file system.

      • Region — required — (String)

        The Amazon Web Services Region in which the destination file system is located.

      • LastReplicatedTimestamp — (Date)

        The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.

Returns:

• (AWS.Request) —

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

/* 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
 });

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.

    • Key — required — (String)

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

    • Value — required — (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.

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.

/* 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
 });

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.

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.

/* 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
 });

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.

var params = {
  SourceFileSystemId: 'STRING_VALUE' /* required */
};
efs.deleteReplicationConfiguration(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: {}) —
  • SourceFileSystemId — (String)

    The ID of the source file system in the replication configuration.

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.

/* 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
 });

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.

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.

        • Key — required — (String)

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

        • Value — required — (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.

        • Uid — required — (Integer)

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

        • Gid — required — (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 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.

          • OwnerUid — required — (Integer)

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

          • OwnerGid — required — (Integer)

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

          • Permissions — required — (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)

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

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.

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 for which to retrieve the BackupPolicy.

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.

      • Status — required — (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.

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.

/* 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"
       }
      ]
     }
    ]
   }
   */
 });

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.

      • OwnerId — required — (String)

        The Amazon Web Services account that created the file system.

      • CreationToken — required — (String)

        The opaque string specified in the request.

      • FileSystemId — required — (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 — required — (Date)

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

      • LifeCycleState — required — (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 — required — (Integer)

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

      • SizeInBytes — required — (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.

        • Value — required — (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.

        • ValueInArchive — (Integer)

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

      • PerformanceMode — required — (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 KMS key 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"
        • "elastic"
      • ProvisionedThroughputInMibps — (Float)

        The amount of provisioned throughput, measured in MiBps, 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 One Zone file systems. 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 is located, and is valid only for One Zone file systems. 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 — required — (Array<map>)

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

        • Key — required — (String)

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

        • Value — required — (String)

          The value of the tag key.

      • FileSystemProtection — (map)

        Describes the protection on the file system.

        • ReplicationOverwriteProtection — (String)

          The status of the file system's replication overwrite protection.

          • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

          • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

          • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

          If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
          • "REPLICATING"
    • 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.

/* 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"
     }
    ]
   }
   */
 });

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)

        The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (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"
        • "AFTER_1_DAY"
        • "AFTER_180_DAYS"
        • "AFTER_270_DAYS"
        • "AFTER_365_DAYS"
      • TransitionToPrimaryStorageClass — (String)

        Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        Possible values include:
        • "AFTER_1_ACCESS"
      • TransitionToArchive — (String)

        The number of days after files were last accessed in primary storage (the Standard storage class) files at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        Possible values include:
        • "AFTER_1_DAY"
        • "AFTER_7_DAYS"
        • "AFTER_14_DAYS"
        • "AFTER_30_DAYS"
        • "AFTER_60_DAYS"
        • "AFTER_90_DAYS"
        • "AFTER_180_DAYS"
        • "AFTER_270_DAYS"
        • "AFTER_365_DAYS"

Returns:

• (AWS.Request) —

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

/* 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"
     }
    ]
   }
   */
 });

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.

      • MountTargetId — required — (String)

        System-assigned mount target ID.

      • FileSystemId — required — (String)

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

      • SubnetId — required — (String)

        The ID of the mount target's subnet.

      • LifeCycleState — required — (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.

/* 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"
    ]
   }
   */
 });

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.

var params = {
  FileSystemId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
efs.describeReplicationConfigurations(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)

    You can retrieve the replication configuration for a specific file system by providing its file system ID.

  • NextToken — (String)

    NextToken is present if the response is paginated. You can use NextToken in a subsequent request to fetch the next page of output.

  • MaxResults — (Integer)

    (Optional) To limit the number of objects returned in a response, you can specify the MaxItems parameter. 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:

    • Replications — (Array<map>)

      The collection of replication configurations that is returned.

      • SourceFileSystemId — required — (String)

        The ID of the source Amazon EFS file system that is being replicated.

      • SourceFileSystemRegion — required — (String)

        The Amazon Web Services Region in which the source EFS file system is located.

      • SourceFileSystemArn — required — (String)

        The Amazon Resource Name (ARN) of the current source file system in the replication configuration.

      • OriginalSourceFileSystemArn — required — (String)

        The Amazon Resource Name (ARN) of the original source EFS file system in the replication configuration.

      • CreationTime — required — (Date)

        Describes when the replication configuration was created.

      • Destinations — required — (Array<map>)

        An array of destination objects. Only one destination object is supported.

        • Status — required — (String)

          Describes the status of the destination EFS file system.

          • The Paused state occurs as a result of opting out of the source or destination Region after the replication configuration was created. To resume replication for the file system, you need to again opt in to the Amazon Web Services Region. For more information, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference Guide.

          • The Error state occurs when either the source or the destination file system (or both) is in a failed state and is unrecoverable. For more information, see Monitoring replication status in the Amazon EFS User Guide. You must delete the replication configuration, and then restore the most recent backup of the failed file system (either the source or the destination) to a new file system.

          Possible values include:
          • "ENABLED"
          • "ENABLING"
          • "DELETING"
          • "ERROR"
          • "PAUSED"
          • "PAUSING"
        • FileSystemId — required — (String)

          The ID of the destination Amazon EFS file system.

        • Region — required — (String)

          The Amazon Web Services Region in which the destination file system is located.

        • LastReplicatedTimestamp — (Date)

          The time when the most recent sync was successfully completed on the destination file system. Any changes to data on the source file system that occurred before this time have been successfully replicated to the destination file system. Any changes that occurred after this time might not be fully replicated.

    • NextToken — (String)

      You can use the NextToken from the previous response in a subsequent request to fetch the additional descriptions.

Returns:

• (AWS.Request) —

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

/* 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"
     }
    ]
   }
   */
 });

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.

      • Key — required — (String)

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

      • Value — required — (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.

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.

      • Key — required — (String)

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

      • Value — required — (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.

/* 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
 });

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.

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

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.

    • Status — required — (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.

      • Status — required — (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.

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 boolean that specifies whether or not to bypass the FileSystemPolicy lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future PutFileSystemPolicy requests on this file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the IAM principal that is making the request from making subsequent PutFileSystemPolicy requests on this 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.

/* 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"
     }
    ]
   }
   */
 });

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  LifecyclePolicies: [ /* required */
    {
      TransitionToArchive: AFTER_1_DAY | AFTER_7_DAYS | AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_90_DAYS | AFTER_180_DAYS | AFTER_270_DAYS | AFTER_365_DAYS,
      TransitionToIA: AFTER_7_DAYS | AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_90_DAYS | AFTER_1_DAY | AFTER_180_DAYS | AFTER_270_DAYS | AFTER_365_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 of the following:

    • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

    • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

      File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

      Note: The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

    • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive 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 must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.
    • TransitionToIA — (String)

      The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (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"
      • "AFTER_1_DAY"
      • "AFTER_180_DAYS"
      • "AFTER_270_DAYS"
      • "AFTER_365_DAYS"
    • TransitionToPrimaryStorageClass — (String)

      Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

      Possible values include:
      • "AFTER_1_ACCESS"
    • TransitionToArchive — (String)

      The number of days after files were last accessed in primary storage (the Standard storage class) files at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

      Possible values include:
      • "AFTER_1_DAY"
      • "AFTER_7_DAYS"
      • "AFTER_14_DAYS"
      • "AFTER_30_DAYS"
      • "AFTER_60_DAYS"
      • "AFTER_90_DAYS"
      • "AFTER_180_DAYS"
      • "AFTER_270_DAYS"
      • "AFTER_365_DAYS"

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)

        The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (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"
        • "AFTER_1_DAY"
        • "AFTER_180_DAYS"
        • "AFTER_270_DAYS"
        • "AFTER_365_DAYS"
      • TransitionToPrimaryStorageClass — (String)

        Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        Possible values include:
        • "AFTER_1_ACCESS"
      • TransitionToArchive — (String)

        The number of days after files were last accessed in primary storage (the Standard storage class) files at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.

        Possible values include:
        • "AFTER_1_DAY"
        • "AFTER_7_DAYS"
        • "AFTER_14_DAYS"
        • "AFTER_30_DAYS"
        • "AFTER_60_DAYS"
        • "AFTER_90_DAYS"
        • "AFTER_180_DAYS"
        • "AFTER_270_DAYS"
        • "AFTER_365_DAYS"

Returns:

• (AWS.Request) —

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

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.

    • Key — required — (String)

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

    • Value — required — (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.

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.

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  ProvisionedThroughputInMibps: 'NUMBER_VALUE',
  ThroughputMode: bursting | provisioned | elastic
};
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"
    • "elastic"
  • ProvisionedThroughputInMibps — (Float)

    (Optional) The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ThroughputMode is set to provisioned. Valid values are 1-3414 MiBps, with the upper limit depending on Region. 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.

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.

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

      • Value — required — (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.

      • ValueInArchive — (Integer)

        The latest known metered size (in bytes) of data stored in the Archive 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 KMS key 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"
      • "elastic"
    • ProvisionedThroughputInMibps — (Float)

      The amount of provisioned throughput, measured in MiBps, 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 One Zone file systems. 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 is located, and is valid only for One Zone file systems. 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.

      • Key — required — (String)

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

      • Value — required — (String)

        The value of the tag key.

    • FileSystemProtection — (map)

      Describes the protection on the file system.

      • ReplicationOverwriteProtection — (String)

        The status of the file system's replication overwrite protection.

        • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

        • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

        • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

        If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
        • "REPLICATING"

Returns:

• (AWS.Request) —

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

var params = {
  FileSystemId: 'STRING_VALUE', /* required */
  ReplicationOverwriteProtection: ENABLED | DISABLED | REPLICATING
};
efs.updateFileSystemProtection(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 to update.

  • ReplicationOverwriteProtection — (String)

    The status of the file system's replication overwrite protection.

    • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

    • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

    • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

    If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
    • "REPLICATING"

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:

    • ReplicationOverwriteProtection — (String)

      The status of the file system's replication overwrite protection.

      • ENABLED – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ENABLED by default.

      • DISABLED – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.

      • REPLICATING – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.

      If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.

      Possible values include:
      • "ENABLED"
      • "DISABLED"
      • "REPLICATING"

Returns:

• (AWS.Request) —

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