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.
New-EFSFileSystem-AvailabilityZoneName <String>-Backup <Boolean>-CreationToken <String>-Encrypted <Boolean>-KmsKeyId <String>-PerformanceMode <PerformanceMode>-ProvisionedThroughputInMibp <Double>-Tag <Tag[]>-ThroughputMode <ThroughputMode>-Select <String>-Force <SwitchParameter>-ClientConfig <AmazonElasticFileSystemConfig>
creating
. 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. us-east-1a
to specify the Availability Zone. For more information about One Zone storage classes, see Using EFS storage classes in the Amazon EFS User Guide.One Zone storage classes are not available in all Availability Zones in Amazon Web Services Regions where Amazon EFS is available. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
true
to enable automatic backups. If you are creating a file system that uses One Zone storage classes, automatic backups are enabled by default. For more information, see Automatic backups in the Amazon EFS User Guide.Default is false
. However, if you specify an AvailabilityZoneName
, the default is true
.Backup is not available in all Amazon Web Services Regions where Amazon EFS is available. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
/aws/elasticfilesystem
, is used to protect the encrypted file system. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
1234abcd-12ab-34cd-56ef-1234567890ab
.arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
.alias/projectKey1
.arn:aws:kms:us-west-2:444455556666:alias/projectKey1
.KmsKeyId
, you must set the CreateFileSystemRequest$Encrypted parameter to true.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.The maxIO
mode is not supported on file systems using One Zone storage classes. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ThroughputMode
is set to provisioned
. The upper limit for throughput is 1024 MiB/s. To increase this limit, contact Amazon Web Services Support. For more information, see Amazon EFS quotas that you can increase in the Amazon EFS User Guide. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ProvisionedThroughputInMibps |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
"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. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
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 throughput in Provisioned Throughput mode 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
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
New-EFSFileSystem
CreationTime : 5/26/2015 4:02:38 PM
CreationToken : 1a2bff54-85e0-4747-bd95-7bc172c4f555
FileSystemId : fs-1a2b3c4d
LifeCycleState : creating
Name :
NumberOfMountTargets : 0
OwnerId : 123456789012
SizeInBytes : Amazon.ElasticFileSystem.Model.FileSystemSize
Creates a new, empty file system. The token used to ensure idempotent creation will be generated automatically and can be accessed from theCreationToken
member of the returned object.
New-EFSFileSystem -CreationToken "MyUniqueToken"Creates a new, empty file system using a custom token to ensure idempotent creation.
AWS Tools for PowerShell: 2.x.y.z