## Spec schema

BackupPlan Spec defines the selected state of BackupPlan.

```yaml
BackupPlan:
  metadata:
    name: string
  spec:
    backupLocation:
      gcsOptions:
        bucket: string
        key: string
        secretRef:
          name: string
      s3Options:
        bucket: string
        caBundle: []string
        endpoint: string
        key: string
        region: string
        secretRef:
          name: string
      type: string
    backupRetainDays: integer
    backupSchedules:
      differential: string
      full: string
      incremental: string
    dbclusterRef: string
    paused: boolean
```

| Field Type Required or optional | Description |
|---|---|
| `name` ||
| `string` *Required* | Name of the BackupPlan resource. |
| `backupLocation` ||
| `object` *Required* | Specifies the remote object storage repository location to store backups. |
| `backupLocation.gcsOptions` ||
| `object` *Optional* | Configuration options for the Cloud Storage repository. |
| `backupLocation.gcsOptions.bucket` ||
| `string` *Required* | Cloud Storage bucket name---for example, `dbs-dump-bucket`. The user must ensure write access to the storage bucket. |
| `backupLocation.gcsOptions.key` ||
| `string` *Required* | Object key prefix for backup dump files---for example, `ods-dump/scottschema.dmp`. |
| `backupLocation.gcsOptions.secretRef` ||
| `object` *Optional* | A reference to the `Secret` resource that stores the Cloud Storage access information. |
| `backupLocation.gcsOptions.secretRef.name` ||
| `string` *Required* | Name of the `Secret` resource. |
| `backupLocation.s3Options` ||
| `object` *Optional* | Configuration options for Amazon S3 or S3-compatible object storage repository. |
| `backupLocation.s3Options.bucket` ||
| `string` *Required* | S3 bucket name---for example, `dbs-dump-bucket`. The user must ensure write access to the storage bucket. |
| `backupLocation.s3Options.caBundle` ||
| `list (string)` *Optional* | Pool of PEM-encoded CA certificates used to validate the S3 storage server certificate. |
| `backupLocation.s3Options.endpoint` ||
| `string` *Optional* | S3 endpoint URL---for example, `https://s3.amazonaws.com`. |
| `backupLocation.s3Options.key` ||
| `string` *Required* | Object key prefix for backup dump files---for example, `ods-dump/scottschema.dmp`. |
| `backupLocation.s3Options.region` ||
| `string` *Required* | AWS S3 region where the bucket resides---for example, `us-west-2`. |
| `backupLocation.s3Options.secretRef` ||
| `object` *Optional* | Reference to the `Secret` containing S3 storage access credentials. |
| `backupLocation.s3Options.secretRef.name` ||
| `string` *Required* | Name of the `Secret` resource. |
| `backupLocation.type` ||
| `string` *Required* | Valid values: `GCS`, `S3`. Type of repository (`S3` for Amazon S3, `GCS` for Cloud Storage), which tells the agent which storage system or API to use. |
| `backupRetainDays` ||
| `integer` *Optional* | Default: `14`; minimum: `1`, maximum: `90`. Number of days after which the service automatically deletes a `Backup`. If specified, a `Backup` created under this BackupPlan is automatically deleted after its age reaches `createTime` + `backupRetainDays`. |
| `backupSchedules` ||
| `object` *Optional* | Defines the schedules for different types of automated backups. Full, differential, and incremental backup types are supported. If not specified, one full backup is taken every day at midnight (`0 0 * * *`). |
| `backupSchedules.differential` ||
| `string` *Optional* | Standard cron expression defining the schedule for automated differential backups. |
| `backupSchedules.full` ||
| `string` *Optional* | Standard cron expression defining the schedule for automated full backups (for example, `0 0 * * *`). |
| `backupSchedules.incremental` ||
| `string` *Optional* | Standard cron expression defining the schedule for automated incremental backups. |
| `dbclusterRef` ||
| `string` *Required* | The name of the `DBCluster` custom resource that this backup plan configures. This field is required and immutable. |
| `paused` ||
| `boolean` *Optional* | Default: `false`. Flag indicating whether backup creation under this backup plan is paused. If set to `true`, the service pauses scheduling new automated backups. |

## Status schema

BackupPlanStatus defines the observed state of BackupPlan.

```yaml
conditions:
- lastTransitionTime: string
  message: string
  observedGeneration: integer
  reason: string
  status: string
  type: string
criticalIncidents:
- code: string
  createTime: string
  message: string
  messageTemplateParams: object
  resource:
    component: string
    location:
      cluster: string
      group: string
      kind: string
      name: string
      namespace: string
      version: string
  stackTrace:
  - component: string
    message: string
  transientUntil: string
lastBackupTime: string
nextBackupTime: string
observedGeneration: integer
phase: string
reconciled: boolean
recoveryWindow:
  begin: string
  end: string
```

| Field Type Required or optional | Description |
|---|---|
| `conditions` ||
| `list (object)` *Optional* | Conditions represent the latest available observations of the Entity's current state. |
| `conditions[].lastTransitionTime` ||
| `string` *Required* | The last time the condition transitioned from one status to another. This is when the underlying condition changed. If that is not known, then use the time when the API field changed. |
| `conditions[].message` ||
| `string` *Required* | A human readable message indicating details about the transition. This can be an empty string. |
| `conditions[].observedGeneration` ||
| `integer` *Optional* | Represents the `.metadata.generation` that the condition was set based upon. For example, if `.metadata.generation` is `12` but the `.status.conditions[x].observedGeneration` is `9`, the condition is out of date with respect to the current state of the instance. |
| `conditions[].reason` ||
| `string` *Required* | maximum length: 1024, minimum length: 1 Contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types might define expected values and meanings for this field. The value must be a CamelCase string. This field cannot be empty. |
| `conditions[].status` ||
| `string` *Required* | Status of the condition, one of `True`, `False`, `Unknown`. |
| `conditions[].type` ||
| `string` *Required* | Maximum length: 316 Type of condition in CamelCase or in `foo.example.com/CamelCase`. |
| `criticalIncidents` ||
| `list (object)` *Required* | A flat list of all active critical incidents. Contains all information about an ongoing critical incident. |
| `criticalIncidents[].code` ||
| `string` *Required* | The error code of this particular error. Error codes are formatted as `DBSE` followed by a number, like `DBSE1012`. |
| `criticalIncidents[].createTime` ||
| `string` *Required* | The timestamp when this Incident is created at the origin. |
| `criticalIncidents[].message` ||
| `string` *Optional* | The incident or error that occurred. |
| `criticalIncidents[].messageTemplateParams` ||
| `object` *Optional* | Contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface. |
| `criticalIncidents[].resource` ||
| `object` *Required* | Contains information about the Database Service component that reported the incident, as well as information about the cluster manager resource. |
| `criticalIncidents[].resource.component` ||
| `string` *Required* | An internal identifier of the Database Service subsystem that reported the incident. |
| `criticalIncidents[].resource.location` ||
| `object` *Optional* | Location where the resource is located. |
| `criticalIncidents[].resource.location.cluster` ||
| `string` *Optional* | The name of the cluster of the affected cluster manager resource. |
| `criticalIncidents[].resource.location.group` ||
| `string` *Optional* | The group name of the cluster manager resource. |
| `criticalIncidents[].resource.location.kind` ||
| `string` *Optional* | The kind of the cluster manager resource. |
| `criticalIncidents[].resource.location.name` ||
| `string` *Optional* | The name of the affected cluster manager resource. |
| `criticalIncidents[].resource.location.namespace` ||
| `string` *Optional* | The namespace of the affected cluster manager resource. |
| `criticalIncidents[].resource.location.version` ||
| `string` *Optional* | The version of the cluster manager resource. |
| `criticalIncidents[].stackTrace` ||
| `list (object)` *Optional* | An unstructured list of messages from the stack trace. |
| `criticalIncidents[].stackTrace.component` ||
| `string` *Optional* | The name of a Database Service component that logged the message. |
| `criticalIncidents[].stackTrace.message` ||
| `string` *Optional* | Logged message. |
| `criticalIncidents[].transientUntil` ||
| `string` *Optional* | If present, `TransientUntil` indicates that the issue must be considered transient until the specified time. |
| `lastBackupTime` ||
| `string` *Optional* | The timestamp for the most recently executed backup. |
| `nextBackupTime` ||
| `string` *Optional* | The timestamp for the next scheduled backup. |
| `observedGeneration` ||
| `integer` *Optional* | The generation observed by the controller. |
| `phase` ||
| `string` *Optional* | The phase of a BackupPlan. |
| `reconciled` ||
| `boolean` *Optional* | Whether the resource was reconciled by the controller. |
| `recoveryWindow` ||
| `object` *Optional* | The available recovery window. |
| `recoveryWindow.begin` ||
| `string` *Optional* | Begin time. |
| `recoveryWindow.end` ||
| `string` *Optional* | End time. |