Restore Custom Resource Definition

Spec schema

RestoreSpec defines the selected state of a Restore resource.

Restore:
  metadata:
    name: string
  spec:
    backup: string
    pointInTime: string
    sourceDBCluster: string

Field

Type
Required or optional

 

Description
backup
string
Optional
The name of the Backup resource to restore from. You must specify either backup or pointInTime, but not both.
pointInTime
string
Optional
Target timestamp for point-in-time recovery. Must be in the past and within the available recovery window. You must specify either backup or pointInTime, but not both.
sourceDBCluster
string
Required
The name of the source DBCluster to restore from.

Status schema

RestoreStatus defines the observed state of a Restore resource.

completeTime: string
conditions:
- lastTransitionTime: string
  message: string
  observedGeneration: integer
  reason: string
  status: string
  type: string
createTime: 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
observedGeneration: integer
phase: string
reconciled: boolean
restoredPointInTime: string

Field

Type
Required or optional

 

Description
completeTime
string
Optional
Completion time of the Restore.
conditions[]
array of objects
Optional
Conditions represent the latest available observations of the entity's current state.
conditions[].lastTransitionTime
string
Required
lastTransitionTime is the last time the condition transitioned from one status to another, which occurs when the underlying condition changed. If the time when the underlying condition changed is unknown, use the time when the API field changed.
conditions[].message
string
Required
message is a human readable message indicating details about the transition. This can be an empty string.
conditions[].observedGeneration
integer
Optional
observedGeneration 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
reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field. The value must be a CamelCase string. This field might not be empty.
conditions[].status
string
Required
The status of the condition. Values can be True, False, or Unknown.
conditions[].type
string
Required
The type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available.
createTime
string
Optional
Creation time of the Restore.
criticalIncidents[]
array of objects
Required
CriticalIncidents is a flat list of all active Critical Incidents.
criticalIncidents[].code
string
Required
Code is the error code of this particular error. Error codes are DBSE+numeric strings, like DBSE1012.
criticalIncidents[].createTime
string
Required
CreateTime is the timestamp when this Incident was created at the origin.
criticalIncidents[].message
string
Optional
Message describes the incident or error that occurred.
criticalIncidents[].messageTemplateParams
object
Optional
MessageTemplateParams contains key-value pairs necessary for generating a user-friendly data-driven version of Message in the user interface.
criticalIncidents[].resource
object
Required
Resource contains information about the Database Service component that reported the incident, as well as information about the target resource.
criticalIncidents[].resource.component
string
Required
Component is an internal identifier of the Database Service subsystem that reported the incident.
criticalIncidents[].resource.location
object
Optional
Location information for the affected resource.
criticalIncidents[].resource.location.cluster
string
Optional
The name of the cluster of the affected resource.
criticalIncidents[].resource.location.group
string
Optional
The Group name of the resource.
criticalIncidents[].resource.location.kind
string
Optional
The Kind of the resource.
criticalIncidents[].resource.location.name
string
Optional
The name of the affected resource.
criticalIncidents[].resource.location.namespace
string
Optional
The namespace of the affected resource.
criticalIncidents[].resource.location.version
string
Optional
The Version of the resource.
criticalIncidents[].stackTrace[]
array of objects
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
Indicates that the issue is considered transient until the specified time.
observedGeneration
integer
Optional
Internal: The generation observed by the controller.
phase
string
Optional
RestorePhase is the phase of a restore.
reconciled
boolean
Optional
Internal: Whether the resource was reconciled by the controller.
restoredPointInTime
string
Optional
Actual point-in-time this restore brings the target DBCluster into. Might be different from value specified in spec.pointInTime.