BackupJob

Enthält detaillierte Informationen zu einem Backup-Auftrag.

Inhalt

AccountId

Die Konto-ID, der der Backup-Auftrag angehört.

Typ: Zeichenfolge

Pattern: ^[0-9]{12}$

Erforderlich: Nein

BackupJobId

Identifiziert eindeutig eine Anfrage AWS Backup zur Sicherung einer Ressource.

Typ: Zeichenfolge

Erforderlich: Nein

BackupOptions

Gibt die Backup-Option für eine ausgewählte Ressource an. Diese Option ist nur für Windows-VSS-Backup-Aufträge (Volume Shadow Copy Service) verfügbar.

Gültige Werte: Stellen Sie diese Option auf "WindowsVSS":"enabled" ein, um die WindowsVSS-Backup-Option zu aktivieren und ein Windows VSS-Backup zu erstellen. Stellen Sie sie auf "WindowsVSS":"disabled" ein, um ein reguläres Backup zu erstellen. Wenn Sie eine ungültige Option angeben, erhalten Sie eine InvalidParameterValueException-Ausnahme.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Schlüssel-Muster: ^[a-zA-Z0-9\-\_\.]{1,50}$

Wertemuster: ^[a-zA-Z0-9\-\_\.]{1,50}$

Erforderlich: Nein

BackupSizeInBytes

Die Größe eines Backups (Wiederherstellungspunkts) in Byte.

Dieser Wert kann je nach Ressourcentyp unterschiedlich dargestellt werden, AWS Backup da Dateninformationen von anderen AWS Diensten abgerufen werden. Beispielsweise kann der zurückgegebene Wert einen Wert von aufweisen0, der vom erwarteten Wert abweichen kann.

Das erwartete Verhalten von Werten nach Ressourcentyp wird wie folgt beschrieben:

• Bei Amazon Aurora, Amazon DocumentDB und Amazon Neptune wird dieser Wert nicht aus dem Vorgang übernommen. GetBackupJobStatus

• Bei Amazon DynamoDB mit erweiterten Funktionen bezieht sich dieser Wert auf die Größe des Wiederherstellungspunkts (Backup).

• Amazon EC2 und Amazon EBS zeigen die als Teil dieses Werts zurückgegebene Volumengröße (bereitgestellter Speicher) an. Amazon EBS gibt keine Informationen zur Backup-Größe zurück. Die Snapshot-Größe hat denselben Wert wie die ursprüngliche Ressource, die gesichert wurde.

• Für Amazon EFS bezieht sich dieser Wert auf die Delta-Bytes, die während einer Sicherung übertragen wurden.

• Amazon FSx füllt diesen Wert nicht aus dem Vorgang GetBackupJobStatus für FSx Dateisysteme auf.

• Eine Amazon RDS-Instance wird als angezeigt0.

• Bei laufenden VMware virtuellen Maschinen wird dieser Wert AWS Backup über einen asynchronen Workflow weitergegeben, was bedeuten kann, dass dieser angezeigte Wert die tatsächliche Backup-Größe unterrepräsentiert.

Type: Long

Erforderlich: Nein

BackupType

Stellt den Backup-Typ für einen Backup-Auftrag dar.

Typ: Zeichenfolge

Erforderlich: Nein

BackupVaultArn

Ein Amazon-Ressourcenname (ARN), der einen Backup-Tresor eindeutig identifiziert, z. B. arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

Typ: Zeichenfolge

Erforderlich: Nein

BackupVaultName

Der Name eines logischen Containers, in dem die Sicherungen gespeichert werden. Backup-Tresore werden durch Namen identifiziert, die für das Konto, mit dem sie erstellt wurden, und die AWS -Region, in der sie erstellt wurden, eindeutig sind.

Typ: Zeichenfolge

Pattern: ^[a-zA-Z0-9\-\_]{2,50}$

Erforderlich: Nein

BytesTransferred

Die Größe in Byte, die zum Zeitpunkt der Abfrage des Auftragsstatus an einen Backup-Tresor übertragen wurden.

Type: Long

Erforderlich: Nein

CompletionDate

Das Datum und die Uhrzeit, zu der ein Auftrag zum Erstellen eines Backup-Auftrags abgeschlossen wird, im Unix-Format und in der koordinierten Weltzeit (UTC). Der Wert von CompletionDate ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

Erforderlich: Nein

CreatedBy

Enthält identifizierende Informationen über die Erstellung eines Backup-Auftrags, einschließlich BackupPlanArn, BackupPlanId, BackupPlanVersion und BackupRuleId des Backup-Plans, mit dem er erstellt wurde.

Typ: RecoveryPointCreator Objekt

Erforderlich: Nein

CreationDate

Das Datum und die Uhrzeit der Erstellung eines Backup-Auftrags im Unix-Zeitformat und in der koordinierten Weltzeit (UTC). Der Wert von CreationDate ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

Erforderlich: Nein

EncryptionKeyArn

Der Amazon-Ressourcenname (ARN) des KMS-Schlüssels, der zur Verschlüsselung des Backups verwendet wurde. Dies kann je nach Tresorkonfiguration ein vom Kunden AWS verwalteter Schlüssel oder ein verwalteter Schlüssel sein.

Typ: Zeichenfolge

Erforderlich: Nein

ExpectedCompletionDate

Das Datum und die Uhrzeit, zu der ein Auftrag zum Sichern von Ressourcen abgeschlossen werden soll, im Unix-Format und in der koordinierten Weltzeit (UTC). Der Wert von ExpectedCompletionDate ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

Erforderlich: Nein

IamRoleArn

Gibt den IAM-Rollen-ARN an, der zum Erstellen des Ziel-Wiederherstellungspunkts verwendet wird. Andere IAM-Rollen als die Standardrolle müssen entweder AWSBackup oder AwsBackup im Rollennamen enthalten. Beispiel, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Rollennamen ohne diese Zeichenfolgen sind nicht berechtigt, Backup-Aufträge auszuführen.

Typ: Zeichenfolge

Erforderlich: Nein

InitiationDate

Das Datum, an dem der Backup-Job initiiert wurde.

Typ: Zeitstempel

Erforderlich: Nein

IsEncrypted

Ein boolescher Wert, der angibt, ob das Backup verschlüsselt ist. Alle Backups in AWS Backup sind verschlüsselt, aber dieses Feld gibt aus Gründen der Transparenz den Verschlüsselungsstatus an.

Typ: Boolesch

Erforderlich: Nein

IsParent

Dies ist ein boolescher Wert, der angibt, dass es sich um einen übergeordneten (zusammengesetzten) Backup-Auftrag handelt.

Typ: Boolesch

Erforderlich: Nein

MessageCategory

Dieser Parameter gibt die Anzahl der Aufträge für die angegebene Nachrichtenkategorie an.

Beispielzeichenfolgen können AccessDenied, SUCCESS, AGGREGATE_ALL oder INVALIDPARAMETERS sein. Eine Liste der MessageCategory Zeichenketten finden Sie unter Überwachung.

Der Wert ANY gibt die Anzahl aller Nachrichtenkategorien zurück.

AGGREGATE_ALL aggregiert die Anzahl der Aufträge für alle Nachrichtenkategorien und gibt die Summe zurück.

Typ: Zeichenfolge

Erforderlich: Nein

ParentJobId

Dadurch wird eine Anforderung an AWS Backup zur Sicherung einer Ressource eindeutig identifiziert. Bei der Rückgabe handelt es sich um die übergeordnete (zusammengesetzte) Auftrags-ID.

Typ: Zeichenfolge

Erforderlich: Nein

PercentDone

Enthält einen geschätzten Prozentsatz der Fertigstellung eines Auftrags zum Zeitpunkt der Abfrage des Auftragsstatus.

Typ: Zeichenfolge

Erforderlich: Nein

RecoveryPointArn

Ein ARN, der einen Wiederherstellungspunkt eindeutig identifiziert, z. B. arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Typ: Zeichenfolge

Erforderlich: Nein

RecoveryPointLifecycle

Gibt den Zeitraum in Tagen an, bevor ein Erholungspunkt in einen Cold Storage übergeht oder gelöscht wird.

In den Archivspeicher übertragene Backups müssen mindestens 90 Tage lang im Archivspeicher gespeichert werden. Daher muss die Aufbewahrungseinstellung auf der Konsole um 90 Tage höher sein als die Einstellung für den Übergang zur Einstellung „Kalt nach Tagen“. Die Einstellung für den Übergang zu „kalt nach Tagen“ kann nicht geändert werden, nachdem ein Backup auf „kalt“ umgestellt wurde.

Ressourcentypen, die auf Cold Storage umgestellt werden können, sind in der Tabelle Verfügbarkeit von Funktionen nach Ressourcen aufgeführt. AWS Backup ignoriert diesen Ausdruck für andere Ressourcentypen.

Um den bestehenden Lebenszyklus und die Aufbewahrungsfristen zu entfernen und Ihre Wiederherstellungspunkte unbegrenzt beizubehalten, geben Sie -1 für MoveToColdStorageAfterDays und an. DeleteAfterDays

Typ: Lifecycle Objekt

Erforderlich: Nein

ResourceArn

Ein ARN bezeichnet eindeutig eine Ressource. Das Format eines ARN hängt vom Ressourcentyp ab.

Typ: Zeichenfolge

Erforderlich: Nein

ResourceName

Der nicht eindeutige Name der Ressource, die zu dem angegebenen Backup gehört.

Typ: Zeichenfolge

Erforderlich: Nein

ResourceType

Der Typ der AWS Ressource, die gesichert werden soll, z. B. ein Amazon Elastic Block Store (Amazon EBS) -Volume oder eine Amazon Relational Database Service (Amazon RDS) -Datenbank. Für Windows Volume Shadow Copy Service (VSS) -Backups ist Amazon EC2 der einzige unterstützte Ressourcentyp.

Typ: Zeichenfolge

Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

Erforderlich: Nein

StartBy

Gibt die Uhrzeit im Unix-Format und in der koordinierten Weltzeit (UTC) an, zu der ein Backup-Auftrag gestartet werden muss, bevor er abgebrochen wird. Der Wert wird berechnet, indem das Startfenster zur geplanten Zeit hinzugefügt wird. Wenn die geplante Zeit also 18:00 Uhr wäre und das Startfenster zwei Stunden beträgt, wäre die StartBy-Uhrzeit am angegebenen Datum 20:00 Uhr. Der Wert von StartBy ist auf Millisekunden genau. Der Wert 1516925490.087 steht beispielsweise für Freitag, 26. Januar 2018, 12:11:30.087 Uhr.

Typ: Zeitstempel

Erforderlich: Nein

State

Der aktuelle Status eines Backup-Auftrags.

Typ: Zeichenfolge

Zulässige Werte: CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

Erforderlich: Nein

StatusMessage

Eine ausführliche Meldung, in der der Status des Backup-Auftrags für eine Ressource erläutert wird.

Typ: Zeichenfolge

Erforderlich: Nein

VaultLockState

Der Sperrstatus des Backup-Tresors. Bei Tresoren mit logischem Air-Gap gibt dies an, ob der Tresor im Compliance-Modus gesperrt ist. Gültige Werte sind LOCKED und UNLOCKED.

Typ: Zeichenfolge

Erforderlich: Nein

VaultType

Der Typ des Backup-Tresors, in dem der Recovery Point gespeichert ist. Gültige Werte gelten BACKUP_VAULT für standardmäßige Backup-Tresore und LOGICALLY_AIR_GAPPED_BACKUP_VAULT für Tresore mit logischem Air-Gap.

Typ: Zeichenfolge

Erforderlich: Nein

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3