Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . fsx ]

create-file-system

Description

Creates a new, empty Amazon FSx file system.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError . If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

  • Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING .
  • Returns the description of the file system.

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

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 returns the file system state along with other information.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-file-system
[--client-request-token <value>]
--file-system-type <value>
--storage-capacity <value>
--subnet-ids <value>
[--security-group-ids <value>]
[--tags <value>]
[--kms-key-id <value>]
[--windows-configuration <value>]
[--lustre-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--client-request-token (string)

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

--file-system-type (string)

The type of Amazon FSx file system to create.

Possible values:

  • WINDOWS
  • LUSTRE

--storage-capacity (integer)

The storage capacity of the file system being created.

For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB.

For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB.

--subnet-ids (list)

The IDs of the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also launched in that subnet's Availability Zone.

Syntax:

"string" "string" ...

--security-group-ids (list)

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

Syntax:

"string" "string" ...

--tags (list)

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--kms-key-id (string)

The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. For more information, see Encrypt in the AWS Key Management Service API Reference .

--windows-configuration (structure)

The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS .

Shorthand Syntax:

ActiveDirectoryId=string,SelfManagedActiveDirectoryConfiguration={DomainName=string,OrganizationalUnitDistinguishedName=string,FileSystemAdministratorsGroup=string,UserName=string,Password=string,DnsIps=[string,string]},ThroughputCapacity=integer,WeeklyMaintenanceStartTime=string,DailyAutomaticBackupStartTime=string,AutomaticBackupRetentionDays=integer,CopyTagsToBackups=boolean

JSON Syntax:

{
  "ActiveDirectoryId": "string",
  "SelfManagedActiveDirectoryConfiguration": {
    "DomainName": "string",
    "OrganizationalUnitDistinguishedName": "string",
    "FileSystemAdministratorsGroup": "string",
    "UserName": "string",
    "Password": "string",
    "DnsIps": ["string", ...]
  },
  "ThroughputCapacity": integer,
  "WeeklyMaintenanceStartTime": "string",
  "DailyAutomaticBackupStartTime": "string",
  "AutomaticBackupRetentionDays": integer,
  "CopyTagsToBackups": true|false
}

--lustre-configuration (structure)

The Lustre configuration for the file system being created. This value is required if FileSystemType is set to LUSTRE .

Shorthand Syntax:

WeeklyMaintenanceStartTime=string,ImportPath=string,ExportPath=string,ImportedFileChunkSize=integer

JSON Syntax:

{
  "WeeklyMaintenanceStartTime": "string",
  "ImportPath": "string",
  "ExportPath": "string",
  "ImportedFileChunkSize": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

FileSystem -> (structure)

The configuration of the file system that was created.

OwnerId -> (string)

The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.

CreationTime -> (timestamp)

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId -> (string)

The system-generated, unique 17-digit ID of the file system.

FileSystemType -> (string)

The type of Amazon FSx file system, either LUSTRE or WINDOWS .

Lifecycle -> (string)

The lifecycle status of the file system:

  • AVAILABLE indicates that the file system is reachable and available for use.
  • CREATING indicates that Amazon FSx is in the process of creating the new file system.
  • DELETING indicates that Amazon FSx is in the process of deleting the file system.
  • FAILED indicates that Amazon FSx was not able to create the file system.
  • MISCONFIGURED indicates that the file system is in a failed but recoverable state.
  • UPDATING indicates that the file system is undergoing a customer initiated update.

FailureDetails -> (structure)

A structure providing details of any failures that occur when creating the file system has failed.

Message -> (string)

A message describing any failures that occurred during file system creation.

StorageCapacity -> (integer)

The storage capacity of the file system in gigabytes (GB).

VpcId -> (string)

The ID of the primary VPC for the file system.

SubnetIds -> (list)

The ID of the subnet to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

(string)

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

NetworkInterfaceIds -> (list)

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

(string)

An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances .

DNSName -> (string)

The DNS name for the file system.

KmsKeyId -> (string)

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

ResourceARN -> (string)

The Amazon Resource Name (ARN) for the file system resource.

Tags -> (list)

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide .

(structure)

Specifies a key-value pair for a resource tag.

Key -> (string)

A value that specifies the TagKey , the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value -> (string)

A value that specifies the TagValue , the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April .

WindowsConfiguration -> (structure)

The configuration for this Microsoft Windows file system.

ActiveDirectoryId -> (string)

The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.

SelfManagedActiveDirectoryConfiguration -> (structure)

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

DomainName -> (string)

The fully qualified domain name of the self-managed AD directory.

OrganizationalUnitDistinguishedName -> (string)

The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.

FileSystemAdministratorsGroup -> (string)

The name of the domain group whose members have administrative privileges for the FSx file system.

UserName -> (string)

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

DnsIps -> (list)

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.

(string)

ThroughputCapacity -> (integer)

The throughput of an Amazon FSx file system, measured in megabytes per second.

MaintenanceOperationsInProgress -> (list)

The list of maintenance operations in progress for this file system.

(string)

An enumeration specifying the currently ongoing maintenance operation.

WeeklyMaintenanceStartTime -> (string)

The preferred time to perform weekly maintenance, in the UTC time zone.

DailyAutomaticBackupStartTime -> (string)

The preferred time to take daily automatic backups, in the UTC time zone.

AutomaticBackupRetentionDays -> (integer)

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

CopyTagsToBackups -> (boolean)

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.

LustreConfiguration -> (structure)

The configuration for the Amazon FSx for Lustre file system.

WeeklyMaintenanceStartTime -> (string)

The UTC time that you want to begin your weekly maintenance window.

DataRepositoryConfiguration -> (structure)

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

ImportPath -> (string)

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix . If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

ExportPath -> (string)

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

ImportedFileChunkSize -> (integer)

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.