Create File System
| efs_create_file_system | R Documentation |
Creates a new, empty file system¶
Description¶
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 create_file_system 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 create_file_system call returns while the file system's lifecycle
state is still creating. You can check the file system creation status
by calling the describe_file_systems 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
PerformanceMode for all file systems. The maxIO mode is a previous
generation performance type that is designed for highly parallelized
workloads that can tolerate higher latencies than the generalPurpose
mode. MaxIO mode is not supported for One Zone file systems or file
systems that use Elastic throughput.
The PerformanceMode 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
create_mount_target. 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.
Usage¶
efs_create_file_system(CreationToken, PerformanceMode, Encrypted,
KmsKeyId, ThroughputMode, ProvisionedThroughputInMibps,
AvailabilityZoneName, Backup, Tags)
Arguments¶
CreationToken |
[required] A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation. |
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 |
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 |
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. |
ThroughputMode |
Specifies the throughput mode for the file system. The mode can
be Default is |
ProvisionedThroughputInMibps |
The throughput, measured in mebibytes per second (MiBps), that
you want to provision for a file system that you're creating. Required
if |
AvailabilityZoneName |
For One Zone file systems, specify 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 |
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. |
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 |
Value¶
A list with the following syntax:
list(
OwnerId = "string",
CreationToken = "string",
FileSystemId = "string",
FileSystemArn = "string",
CreationTime = as.POSIXct(
"2015-01-01"
),
LifeCycleState = "creating"|"available"|"updating"|"deleting"|"deleted"|"error",
Name = "string",
NumberOfMountTargets = 123,
SizeInBytes = list(
Value = 123,
Timestamp = as.POSIXct(
"2015-01-01"
),
ValueInIA = 123,
ValueInStandard = 123,
ValueInArchive = 123
),
PerformanceMode = "generalPurpose"|"maxIO",
Encrypted = TRUE|FALSE,
KmsKeyId = "string",
ThroughputMode = "bursting"|"provisioned"|"elastic",
ProvisionedThroughputInMibps = 123.0,
AvailabilityZoneName = "string",
AvailabilityZoneId = "string",
Tags = list(
list(
Key = "string",
Value = "string"
)
),
FileSystemProtection = list(
ReplicationOverwriteProtection = "ENABLED"|"DISABLED"|"REPLICATING"
)
)
Request syntax¶
svc$create_file_system(
CreationToken = "string",
PerformanceMode = "generalPurpose"|"maxIO",
Encrypted = TRUE|FALSE,
KmsKeyId = "string",
ThroughputMode = "bursting"|"provisioned"|"elastic",
ProvisionedThroughputInMibps = 123.0,
AvailabilityZoneName = "string",
Backup = TRUE|FALSE,
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
Examples¶
## Not run:
# This operation creates a new, encrypted file system with automatic
# backups enabled, and the default generalpurpose performance mode.
svc$create_file_system(
Backup = TRUE,
CreationToken = "tokenstring",
Encrypted = TRUE,
PerformanceMode = "generalPurpose",
Tags = list(
list(
Key = "Name",
Value = "MyFileSystem"
)
)
)
## End(Not run)