NodeBackupConfiguration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-node-backup-configuration-schema.json",
  "title": "NodeBackupConfiguration",
  "description": "The information about the NodeBackupConfiguration.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-bds-api-openapi.yml#/components/schemas/NodeBackupConfiguration",
  "properties": {
    "backupType": {
      "description": "Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.",
      "type": "string",
      "x-obmcs-enumref": "#/definitions/NodeBackup/backupType"
    },
    "bdsInstanceId": {
      "description": "The OCID of the bdsInstance which is the parent resource id.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "displayName": {
      "description": "A user-friendly name. Only ASCII alphanumeric characters with no spaces allowed. The name does not have to be unique, and it may be changed. Avoid entering confidential information.",
      "maxLength": 255,
      "minLength": 8,
      "type": "string"
    },
    "id": {
      "description": "The unique identifier for the NodeBackupConfiguration.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "levelTypeDetails": {
      "$ref": "#/$defs/LevelTypeDetails"
    },
    "lifecycleState": {
      "description": "The state of the NodeBackupConfiguration.",
      "enum": [
        "CREATING",
        "ACTIVE",
        "UPDATING",
        "DELETING",
        "DELETED",
        "FAILED"
      ],
      "type": "string"
    },
    "numberOfBackupsToRetain": {
      "default": 3,
      "description": "Number of backup copies to retain.",
      "maximum": 5,
      "minimum": 1,
      "type": "integer"
    },
    "schedule": {
      "description": "Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported.\n",
      "format": "x-obmcs-recurring-time",
      "type": "string",
      "x-example": "FREQ=WEEKLY;BYDAY=MO,TU,WE;BYHOUR=10 - Triggers on every Monday, Tuesday and Wednesday of the week at 10:00 am\nFREQ=WEEKLY;BYDAY=FR;BYHOUR=18 - Triggers on every Friday of the week at 06:00 pm\n"
    },
    "timeCreated": {
      "description": "The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string.\n",
      "format": "date-time",
      "type": "string"
    },
    "timezone": {
      "default": "Etc/UTC",
      "description": "The time zone of the execution schedule, in IANA time zone database name format",
      "format": "x-obmcs-time-zone",
      "type": "string"
    }
  },
  "required": [
    "id",
    "bdsInstanceId",
    "displayName",
    "lifecycleState",
    "timeCreated",
    "timeUpdated",
    "timezone",
    "schedule",
    "numberOfBackupsToRetain",
    "levelTypeDetails"
  ],
  "type": "object",
  "$defs": {
    "LevelTypeDetails": {
      "description": "Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration.",
      "properties": {
        "levelType": {
          "description": "Type of level used to trigger the creation of a new node backup configuration or node replacement configuration.",
          "enum": [
            "NODE_LEVEL",
            "NODE_TYPE_LEVEL"
          ],
          "type": "string"
        }
      },
      "required": [
        "levelType"
      ],
      "type": "object"
    }
  }
}