Amazon EFS · JSON Structure

Efs Openapi File System Structure

FileSystem schema from Amazon EFS Amazon Elastic File System (EFS) API

Type: object Properties: 15
Amazon Web ServicesEFSElastic File SystemFile StorageNFSServerlessStorage

FileSystem is a JSON Structure definition published by Amazon EFS, describing 15 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

FileSystemId FileSystemArn CreationToken OwnerId CreationTime LifeCycleState Name NumberOfMountTargets SizeInBytes PerformanceMode Encrypted KmsKeyId ThroughputMode ProvisionedThroughputInMibps Tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-efs/refs/heads/main/json-structure/efs-openapi-file-system-structure.json",
  "name": "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": "datetime",
      "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": "int32",
      "description": "The current number of mount targets that the file system has."
    },
    "SizeInBytes": {
      "type": "object",
      "properties": {
        "Value": {
          "type": "int32",
          "description": "The latest known metered size of data stored in the file system, in bytes."
        },
        "Timestamp": {
          "type": "datetime"
        },
        "ValueInIA": {
          "type": "int32"
        },
        "ValueInStandard": {
          "type": "int32"
        }
      },
      "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": "double",
      "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."
    }
  }
}