Class CreateFileSystemCommandProtected

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's Amazon Web Services account with the specified creation token, this operation does the following:

• Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

• Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

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

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation accepts an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS performance modes.

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

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

Example

Use a bare-bones client and the command you need to make an API call.

import { EFSClient, CreateFileSystemCommand } from "@aws-sdk/client-efs"; // ES Modules import
// const { EFSClient, CreateFileSystemCommand } = require("@aws-sdk/client-efs"); // CommonJS import
const client = new EFSClient(config);
const command = new CreateFileSystemCommand(input);
const response = await client.send(command);

See

• CreateFileSystemCommandInput for command's input shape.
• CreateFileSystemCommandOutput for command's response shape.
• config for EFSClient's config shape.

Throws

BadRequest (client fault)

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

Throws

FileSystemAlreadyExists (client fault)

Returned if the file system you are trying to create already exists, with the creation token you provided.

Throws

FileSystemLimitExceeded (client fault)

Returned if the Amazon Web Services account has already created the maximum number of file systems allowed per account.

Throws

InsufficientThroughputCapacity (server fault)

Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from Bursting Throughput to Provisioned Throughput mode. Try again later.

Throws

InternalServerError (server fault)

Returned if an error occurred on the server side.

Throws

ThroughputLimitExceeded (client fault)

Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

Throws

UnsupportedAvailabilityZone (client fault)

Returned if the requested Amazon EFS functionality is not available in the specified Availability Zone.

Example

To create a new file system

// This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode.
const input = {
  "Backup": true,
  "CreationToken": "tokenstring",
  "Encrypted": true,
  "PerformanceMode": "generalPurpose",
  "Tags": [
    {
      "Key": "Name",
      "Value": "MyFileSystem"
    }
  ]
};
const command = new CreateFileSystemCommand(input);
const response = await client.send(command);
/* response ==
{
  "CreationTime": "1481841524.0",
  "CreationToken": "tokenstring",
  "Encrypted": true,
  "FileSystemId": "fs-01234567",
  "LifeCycleState": "creating",
  "NumberOfMountTargets": 0,
  "OwnerId": "012345678912",
  "PerformanceMode": "generalPurpose",
  "SizeInBytes": {
    "Value": 0
  },
  "Tags": [
    {
      "Key": "Name",
      "Value": "MyFileSystem"
    }
  ]
}
*/
// example id: to-create-a-new-file-system-1481840798547