Amazon RDS · Schema

DBSnapshot

Describes an Amazon RDS DB snapshot

Cloud DatabasesDatabase ServiceDBaaSManaged DatabasesRelational Databases

Properties

Name	Type	Description
dBSnapshotIdentifier	string	The identifier for the DB snapshot
dBInstanceIdentifier	string	The DB instance identifier of the source DB instance
snapshotCreateTime	string	The time when the snapshot was taken
engine	string	The database engine for the snapshot
engineVersion	string	The version of the database engine
status	string	The status of the DB snapshot
allocatedStorage	integer	The allocated storage size in GiB
port	integer	The port that the database engine was listening on at snapshot time
availabilityZone	string	The Availability Zone where the snapshot was created
vpcId	string	The VPC ID associated with the DB snapshot
instanceCreateTime	string	The time when the source DB instance was created
masterUsername	string	The master username for the DB snapshot
snapshotType	string	The type of the DB snapshot
encrypted	boolean	Whether the DB snapshot is encrypted
storageType	string	The storage type associated with the DB snapshot
dBSnapshotArn	string	The Amazon Resource Name (ARN) for the DB snapshot
tags	array	Tags assigned to the DB snapshot

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-rds/refs/heads/main/json-schema/amazon-rds-openapi-db-snapshot-schema.json",
  "title": "DBSnapshot",
  "description": "Describes an Amazon RDS DB snapshot",
  "type": "object",
  "properties": {
    "dBSnapshotIdentifier": {
      "type": "string",
      "description": "The identifier for the DB snapshot"
    },
    "dBInstanceIdentifier": {
      "type": "string",
      "description": "The DB instance identifier of the source DB instance"
    },
    "snapshotCreateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the snapshot was taken"
    },
    "engine": {
      "type": "string",
      "description": "The database engine for the snapshot"
    },
    "engineVersion": {
      "type": "string",
      "description": "The version of the database engine"
    },
    "status": {
      "type": "string",
      "description": "The status of the DB snapshot",
      "enum": [
        "available",
        "creating",
        "deleting",
        "copying"
      ]
    },
    "allocatedStorage": {
      "type": "integer",
      "description": "The allocated storage size in GiB"
    },
    "port": {
      "type": "integer",
      "description": "The port that the database engine was listening on at snapshot time"
    },
    "availabilityZone": {
      "type": "string",
      "description": "The Availability Zone where the snapshot was created"
    },
    "vpcId": {
      "type": "string",
      "description": "The VPC ID associated with the DB snapshot"
    },
    "instanceCreateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The time when the source DB instance was created"
    },
    "masterUsername": {
      "type": "string",
      "description": "The master username for the DB snapshot"
    },
    "snapshotType": {
      "type": "string",
      "description": "The type of the DB snapshot",
      "enum": [
        "automated",
        "manual",
        "shared",
        "public",
        "awsbackup"
      ]
    },
    "encrypted": {
      "type": "boolean",
      "description": "Whether the DB snapshot is encrypted"
    },
    "storageType": {
      "type": "string",
      "description": "The storage type associated with the DB snapshot"
    },
    "dBSnapshotArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) for the DB snapshot"
    },
    "tags": {
      "type": "array",
      "description": "Tags assigned to the DB snapshot",
      "items": {
        "$ref": "#/components/schemas/Tag"
      }
    }
  }
}