Amazon FSx
API Reference

FileSystem

A description of a specific Amazon FSx file system.

Contents

CreationTime

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

Type: Timestamp

Required: No

DNSName

The DNS name for the file system.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 275.

Pattern: ^(fsi?-[0-9a-f]{8,}\..{4,253})$

Required: No

FailureDetails

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

Type: FileSystemFailureDetails object

Required: No

FileSystemId

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

Type: String

Length Constraints: Minimum length of 11. Maximum length of 21.

Pattern: ^(fs-[0-9a-f]{8,})$

Required: No

FileSystemType

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

Type: String

Valid Values: WINDOWS | LUSTRE

Required: No

KmsKeyId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|arn:aws[a-z-]{0,7}:kms:[a-z]{2}-[a-z-]{4,}-\d+:\d{12}:(key|alias)\/([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|[a-zA-Z0-9:\/_-]+)|alias\/[a-zA-Z0-9:\/_-]+$

Required: No

Lifecycle

The lifecycle status of the file system, following are the possible values and what they mean:

  • AVAILABLE - The file system is in a healthy state, and is reachable and available for use.

  • CREATING - Amazon FSx is creating the new file system.

  • DELETING - Amazon FSx is deleting an existing file system.

  • FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable 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.

Type: String

Valid Values: AVAILABLE | CREATING | FAILED | DELETING | MISCONFIGURED | UPDATING

Required: No

LustreConfiguration

The configuration for the Amazon FSx for Lustre file system.

Type: LustreFileSystemConfiguration object

Required: No

NetworkInterfaceIds

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.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Minimum length of 12. Maximum length of 21.

Pattern: ^(eni-[0-9a-f]{8,})$

Required: No

OwnerId

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.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

Required: No

ResourceARN

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

Type: String

Length Constraints: Minimum length of 8. Maximum length of 512.

Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$

Required: No

StorageCapacity

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

Type: Integer

Valid Range: Minimum value of 1.

Required: No

SubnetIds

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.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: ^(subnet-[0-9a-f]{8,})$

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

VpcId

The ID of the primary VPC for the file system.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 21.

Pattern: ^(vpc-[0-9a-f]{8,})$

Required: No

WindowsConfiguration

The configuration for this Microsoft Windows file system.

Type: WindowsFileSystemConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: