Struct BackupCredentialsArgs 

#[non_exhaustive]
pub struct BackupCredentialsArgs {
    pub purpose: Option<BackupPurpose>,
    pub run_id: Option<Uuid>,
    pub type_: String,
}

Request body for minting short-lived S3 credentials for a backup or restore run.

JSON schema

{
 "description": "Request body for minting short-lived S3 credentials for a backup or\nrestore run.",
 "type": "object",
 "required": [
   "type"
 ],
 "properties": {
   "purpose": {
     "description": "What the credentials will be used for. `backup` (the default) grants\nwrite access for uploading backups; `restore` grants strictly read-only\naccess. Either way the credentials are scoped to the group's backup\nstorage only.",
     "$ref": "#/components/schemas/BackupPurpose"
   },
   "run_id": {
     "description": "This must be the run-uuid the client minted for this run.\nThe field is optional only so older clients don't break; it WILL be made\nmandatory in future.",
     "type": [
       "string",
       "null"
     ],
     "format": "uuid"
   },
   "type": {
     "description": "The backup type the credentials are for (e.g. `tamanu-postgres`). For a\n`backup`, the type must be an enabled capability of this server or the\nsubject of a pending \"backup now\" request; for a `restore`, the server's\nrestore window must be open (an operator allows restores for it in\ncanopy). Otherwise the request is rejected with 409.",
     "type": "string"
   }
 }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

purpose: Option<BackupPurpose>

What the credentials will be used for. backup (the default) grants write access for uploading backups; restore grants strictly read-only access. Either way the credentials are scoped to the group’s backup storage only.

run_id: Option<Uuid>

This must be the run-uuid the client minted for this run. The field is optional only so older clients don’t break; it WILL be made mandatory in future.

type_: String

The backup type the credentials are for (e.g. tamanu-postgres). For a backup, the type must be an enabled capability of this server or the subject of a pending “backup now” request; for a restore, the server’s restore window must be open (an operator allows restores for it in canopy). Otherwise the request is rejected with 409.

Implementations

impl BackupCredentialsArgs

pub fn builder() -> BackupCredentialsArgsBuilder

Create an instance of BackupCredentialsArgs using the builder syntax

Trait Implementations

impl Clone for BackupCredentialsArgs

fn clone(&self) -> BackupCredentialsArgs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BackupCredentialsArgs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BackupCredentialsArgs

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BackupCredentialsArgs

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.