• Public
  • Public/Protected
  • All

Interface FileSystemDescription

A description of the file system.




Optional AvailabilityZoneId

AvailabilityZoneId: undefined | string

The unique and consistent identifier of the Availability Zone in which the file system's One Zone storage classes exist. 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.

Optional AvailabilityZoneName

AvailabilityZoneName: undefined | string

Describes the Amazon Web Services Availability Zone in which the file system is located, and is valid only for file systems using One Zone storage classes. For more information, see Using EFS storage classes in the Amazon EFS User Guide.


CreationTime: Date | undefined

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


CreationToken: string | undefined

The opaque string specified in the request.

Optional Encrypted

Encrypted: undefined | false | true

A Boolean value that, if true, indicates that the file system is encrypted.

Optional FileSystemArn

FileSystemArn: undefined | 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


FileSystemId: string | undefined

The ID of the file system, assigned by Amazon EFS.

Optional KmsKeyId

KmsKeyId: undefined | string

The ID of an KMS key used to protect the encrypted file system.


LifeCycleState: LifeCycleState | string | undefined

The lifecycle phase of the file system.

Optional Name

Name: undefined | 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: number | undefined

The current number of mount targets that the file system has. For more information, see CreateMountTarget.


OwnerId: string | undefined

The Amazon Web Services account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.


PerformanceMode: PerformanceMode | string | undefined

The performance mode of the file system.

Optional ProvisionedThroughputInMibps

ProvisionedThroughputInMibps: undefined | number

The amount of provisioned throughput, measured in MiB/s, for the file system. Valid for file systems using ThroughputMode set to provisioned.


SizeInBytes: FileSystemSize | undefined

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.


Tags: Tag[] | undefined

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

Optional ThroughputMode

ThroughputMode: ThroughputMode | string

Displays the file system's throughput mode. For more information, see Throughput modes in the Amazon EFS User Guide.