EFS / Client / create_file_system

create_file_system

EFS.Client.create_file_system(**kwargs)

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.

Note

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.

Note

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.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.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=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• CreationToken (string) –

  [REQUIRED]

  A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

  This field is autopopulated if not provided.

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

  Warning

  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.

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

  Warning

  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.

• 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 (list) –

  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.

  • (dict) –

    A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: `` + - = . _ : /``.

    • Key (string) – [REQUIRED]

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

    • Value (string) – [REQUIRED]

      The value of the tag key.

Return type:

dict

Returns:

Response Syntax

{
    'OwnerId': 'string',
    'CreationToken': 'string',
    'FileSystemId': 'string',
    'FileSystemArn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'LifeCycleState': 'creating'|'available'|'updating'|'deleting'|'deleted'|'error',
    'Name': 'string',
    'NumberOfMountTargets': 123,
    'SizeInBytes': {
        'Value': 123,
        'Timestamp': datetime(2015, 1, 1),
        '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': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'FileSystemProtection': {
        'ReplicationOverwriteProtection': 'ENABLED'|'DISABLED'|'REPLICATING'
    }
}

Response Structure

• (dict) –

  A description of the file system.

  • 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 (datetime) –

    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.

  • 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 (dict) –

    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 (integer) –

      The latest known metered size (in bytes) of data stored in the file system.

    • Timestamp (datetime) –

      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.

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

  • 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 (list) –

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

    • (dict) –

      A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: `` + - = . _ : /``.

      • Key (string) –

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

      • Value (string) –

        The value of the tag key.

  • FileSystemProtection (dict) –

    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.

Exceptions

• EFS.Client.exceptions.BadRequest

• EFS.Client.exceptions.InternalServerError

• EFS.Client.exceptions.FileSystemAlreadyExists

• EFS.Client.exceptions.FileSystemLimitExceeded

• EFS.Client.exceptions.InsufficientThroughputCapacity

• EFS.Client.exceptions.ThroughputLimitExceeded

• EFS.Client.exceptions.UnsupportedAvailabilityZone

Examples

This operation creates a new, encrypted file system with automatic backups enabled, and the default generalpurpose performance mode.

response = client.create_file_system(
    Backup=True,
    CreationToken='tokenstring',
    Encrypted=True,
    PerformanceMode='generalPurpose',
    Tags=[
        {
            'Key': 'Name',
            'Value': 'MyFileSystem',
        },
    ],
)

print(response)

Expected Output:

{
    'CreationTime': datetime(2016, 12, 15, 22, 38, 44, 3, 350, 0),
    'CreationToken': 'tokenstring',
    'Encrypted': True,
    'FileSystemId': 'fs-01234567',
    'LifeCycleState': 'creating',
    'NumberOfMountTargets': 0,
    'OwnerId': '012345678912',
    'PerformanceMode': 'generalPurpose',
    'SizeInBytes': {
        'Value': 0,
    },
    'Tags': [
        {
            'Key': 'Name',
            'Value': 'MyFileSystem',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}