AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the CreateFileSystem operation. 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 all
file systems. File systems using the maxIO
mode is a previous generation performance
type that is designed for highly parallelized workloads that can tolerate higher latencies
than the General Purpose mode. Max I/O mode is not supported for One Zone file systems
or file systems that use Elastic throughput.
Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
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.
File systems can be tagged on creation. If tags are specified in the creation action,
IAM performs additional authorization on the elasticfilesystem:TagResource
action to verify if users have permissions to create tags. Therefore, you must grant
explicit permissions to use the elasticfilesystem:TagResource
action. For more
information, see Granting
permissions to tag resources during creation.
Namespace: Amazon.ElasticFileSystem.Model
Assembly: AWSSDK.ElasticFileSystem.dll
Version: 3.x.y.z
public class CreateFileSystemRequest : AmazonElasticFileSystemRequest IAmazonWebServiceRequest
The CreateFileSystemRequest type exposes the following members
Name | Description | |
---|---|---|
CreateFileSystemRequest() |
Empty constructor used to set properties independently even when a simple constructor is available |
|
CreateFileSystemRequest(string) |
Instantiates CreateFileSystemRequest with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
AvailabilityZoneName | System.String |
Gets and sets the property AvailabilityZoneName.
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 One Zone file systems are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available. |
|
Backup | System.Boolean |
Gets and sets the property Backup.
Specifies whether automatic backups are enabled on the file system that you are creating.
Set the value to
Default is Backup is not available in all Amazon Web Services Regions where Amazon EFS is available. |
|
CreationToken | System.String |
Gets and sets the property CreationToken. A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation. |
|
Encrypted | System.Boolean |
Gets and sets the property Encrypted.
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, |
|
KmsKeyId | System.String |
Gets and sets the property KmsKeyId. 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:
If you use EFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with Amazon EFS file systems. |
|
PerformanceMode | Amazon.ElasticFileSystem.PerformanceMode |
Gets and sets the property PerformanceMode.
The Performance mode of the file system. We recommend Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
Default is |
|
ProvisionedThroughputInMibps | System.Double |
Gets and sets the property ProvisionedThroughputInMibps.
The throughput, measured in mebibytes per second (MiBps), that you want to provision
for a file system that you're creating. Required if |
|
Tags | System.Collections.Generic.List<Amazon.ElasticFileSystem.Model.Tag> |
Gets and sets the property Tags.
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 |
|
ThroughputMode | Amazon.ElasticFileSystem.ThroughputMode |
Gets and sets the property ThroughputMode.
Specifies the throughput mode for the file system. The mode can be
Default is |
This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode.
var client = new AmazonElasticFileSystemClient(); var response = client.CreateFileSystem(new CreateFileSystemRequest { Backup = true, CreationToken = "tokenstring", Encrypted = true, PerformanceMode = "generalPurpose", Tags = new List<Tag> { new Tag { Key = "Name", Value = "MyFileSystem" } } }); DateTime creationTime = response.CreationTime; string creationToken = response.CreationToken; bool encrypted = response.Encrypted; string fileSystemId = response.FileSystemId; string lifeCycleState = response.LifeCycleState; int numberOfMountTargets = response.NumberOfMountTargets; string ownerId = response.OwnerId; string performanceMode = response.PerformanceMode; FileSystemSize sizeInBytes = response.SizeInBytes; List<Tag> tags = response.Tags;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5