Amazon EFS · Schema
FileSystem
FileSystem schema from Amazon EFS Amazon Elastic File System (EFS) API
Amazon Web ServicesEFSElastic File SystemFile StorageNFSServerlessStorage
Properties
| Name | Type | Description |
|---|---|---|
| FileSystemId | string | The ID of the file system. |
| FileSystemArn | string | The Amazon Resource Name (ARN) of the file system. |
| CreationToken | string | The opaque string specified in the request. |
| OwnerId | string | The AWS account that created the file system. |
| CreationTime | string | The time that the file system was created. |
| LifeCycleState | string | The lifecycle phase of the file system. |
| Name | string | The value of the Name tag if set. |
| NumberOfMountTargets | integer | The current number of mount targets that the file system has. |
| SizeInBytes | object | The latest known metered size of data stored in the file system. |
| 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 the KMS key used for encryption. |
| ThroughputMode | string | Displays the throughput mode for the file system. |
| ProvisionedThroughputInMibps | number | The amount of provisioned throughput, in MiB/s. |
| Tags | array | The tags associated with the file system. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-efs/refs/heads/main/json-schema/efs-openapi-file-system-schema.json",
"title": "FileSystem",
"description": "FileSystem schema from Amazon EFS Amazon Elastic File System (EFS) API",
"type": "object",
"properties": {
"FileSystemId": {
"type": "string",
"description": "The ID of the file system."
},
"FileSystemArn": {
"type": "string",
"description": "The Amazon Resource Name (ARN) of the file system."
},
"CreationToken": {
"type": "string",
"description": "The opaque string specified in the request."
},
"OwnerId": {
"type": "string",
"description": "The AWS account that created the file system."
},
"CreationTime": {
"type": "string",
"format": "date-time",
"description": "The time that the file system was created."
},
"LifeCycleState": {
"type": "string",
"enum": [
"creating",
"available",
"updating",
"deleting",
"deleted",
"error"
],
"description": "The lifecycle phase of the file system."
},
"Name": {
"type": "string",
"description": "The value of the Name tag if set."
},
"NumberOfMountTargets": {
"type": "integer",
"description": "The current number of mount targets that the file system has."
},
"SizeInBytes": {
"type": "object",
"properties": {
"Value": {
"type": "integer",
"description": "The latest known metered size of data stored in the file system, in bytes."
},
"Timestamp": {
"type": "string",
"format": "date-time"
},
"ValueInIA": {
"type": "integer"
},
"ValueInStandard": {
"type": "integer"
}
},
"description": "The latest known metered size of data stored in the file system."
},
"PerformanceMode": {
"type": "string",
"enum": [
"generalPurpose",
"maxIO"
],
"description": "The performance mode of the file system."
},
"Encrypted": {
"type": "boolean",
"description": "A Boolean value that, if true, indicates that the file system is encrypted."
},
"KmsKeyId": {
"type": "string",
"description": "The ID of the KMS key used for encryption."
},
"ThroughputMode": {
"type": "string",
"enum": [
"bursting",
"provisioned",
"elastic"
],
"description": "Displays the throughput mode for the file system."
},
"ProvisionedThroughputInMibps": {
"type": "number",
"description": "The amount of provisioned throughput, in MiB/s."
},
"Tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Key": {
"type": "string"
},
"Value": {
"type": "string"
}
}
},
"description": "The tags associated with the file system."
}
}
}