BackupJob - AWS Backup
Table des matièresconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

BackupJob

Contient des informations détaillées sur une tâche de sauvegarde.

Table des matières

AccountId

ID de compte du propriétaire de la tâche de sauvegarde.

Type : String

Modèle : ^[0-9]{12}$

Obligatoire : non

BackupJobId

Identifie de manière unique une demande AWS Backup de sauvegarde d'une ressource.

Type : chaîne

Obligatoire : non

BackupOptions

Spécifie l'option de sauvegarde pour une ressource sélectionnée. Cette option est uniquement disponible pour les tâches de sauvegarde Windows Volume Shadow Copy Service (VSS).

Valeurs valides : définissez sur "WindowsVSS":"enabled" pour activer l'option de sauvegarde WindowsVSS et créer une sauvegarde Windows VSS. Définissez sur "WindowsVSS":"disabled" pour créer une sauvegarde régulière. Si vous spécifiez une option non valide, vous obtenez une exception InvalidParameterValueException.

Type : mappage chaîne/chaîne

Modèle de clé :^[a-zA-Z0-9\-\_\.]{1,50}$

Modèle de valeur : ^[a-zA-Z0-9\-\_\.]{1,50}$

Obligatoire : non

BackupSizeInBytes

Taille, en octets, d'une sauvegarde (point de restauration).

Cette valeur peut s'afficher différemment selon le type de ressource, car AWS Backup elle extrait des informations de données provenant d'autres AWS services. Par exemple, la valeur renvoyée peut afficher une valeur de0, qui peut être différente de la valeur prévue.

Le comportement attendu pour les valeurs par type de ressource est décrit comme suit :

  • Amazon Aurora, Amazon DocumentDB et Amazon Neptune n'ont pas cette valeur renseignée à partir de l'opération. GetBackupJobStatus

  • Pour Amazon DynamoDB doté de fonctionnalités avancées, cette valeur fait référence à la taille du point de restauration (sauvegarde).

  • Amazon EC2 et Amazon EBS indiquent la taille du volume (stockage provisionné) renvoyé dans le cadre de cette valeur. Amazon EBS ne renvoie pas d'informations sur la taille de sauvegarde ; la taille de l'instantané aura la même valeur que la ressource d'origine qui a été sauvegardée.

  • Pour Amazon EFS, cette valeur fait référence aux octets delta transférés lors d'une sauvegarde.

  • Amazon FSx ne renseigne pas cette valeur à partir de l'opération GetBackupJobStatus pour les systèmes de FSx fichiers.

  • Une instance Amazon RDS s'affichera sous la forme0.

  • Pour les machines virtuelles en cours d'exécution VMware, cette valeur est transmise AWS Backup via un flux de travail asynchrone, ce qui peut signifier que la valeur affichée peut sous-représenter la taille réelle de la sauvegarde.

Type : long

Obligatoire : non

BackupType

Représente le type de sauvegarde pour une tâche de sauvegarde.

Type : chaîne

Obligatoire : non

BackupVaultArn

Amazon Resource Name (ARN) qui identifie de façon unique un coffre-fort de sauvegarde ; par exemple, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault.

Type : chaîne

Obligatoire : non

BackupVaultName

Le nom d'un conteneur logique où les sauvegardes sont stockées. Les coffres-forts de sauvegarde sont identifiés par des noms spécifiques pour le compte utilisé pour les créer et la région AWS dans laquelle ils sont créés.

Type : String

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

Obligatoire : non

BytesTransferred

Taille en octets transférée vers un coffre-fort de sauvegarde au moment où le statut de la tâche a été demandé.

Type : long

Obligatoire : non

CompletionDate

Date et heure de fin d'une tâche de création d'une tâche de sauvegarde, au format Unix et au format UTC (temps universel coordonné). La valeur de CompletionDate est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.

Type : Timestamp

Obligatoire : non

CreatedBy

Contient des informations d'identification relatives à la création d'une tâche de sauvegarde, dont BackupPlanArn, BackupPlanId, BackupPlanVersion et BackupRuleId du plan de sauvegarde utilisé pour la créer.

Type : objet RecoveryPointCreator

Obligatoire : non

CreationDate

Date et heure de création d'une tâche de sauvegarde, au format Unix et au format UTC (temps universel coordonné). La valeur de CreationDate est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.

Type : Timestamp

Obligatoire : non

EncryptionKeyArn

Le nom de ressource Amazon (ARN) de la clé KMS utilisée pour chiffrer la sauvegarde. Il peut s'agir d'une clé gérée par le client ou d'une clé AWS gérée, selon la configuration du coffre-fort.

Type : chaîne

Obligatoire : non

ExpectedCompletionDate

Date et heure de fin attendues d'une tâche de sauvegarde des ressources, au format Unix et au format UTC (temps universel coordonné). La valeur de ExpectedCompletionDate est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.

Type : Timestamp

Obligatoire : non

IamRoleArn

Spécifie l'ARN du rôle IAM utilisé pour créer le point de récupération cible. Les rôles IAM autres que le rôle par défaut doivent inclure AWSBackup ou AwsBackup dans le nom du rôle. Par exemple, arn:aws:iam::123456789012:role/AWSBackupRDSAccess. Les noms de rôles dépourvus de ces chaînes ne sont pas autorisés à effectuer des tâches de sauvegarde.

Type : chaîne

Obligatoire : non

InitiationDate

Date à laquelle la tâche de sauvegarde a été lancée.

Type : Timestamp

Obligatoire : non

IsEncrypted

Valeur booléenne indiquant si la sauvegarde est cryptée. Toutes les sauvegardes AWS Backup sont cryptées, mais ce champ indique l'état du chiffrement pour des raisons de transparence.

Type : booléen

Obligatoire : non

IsParent

Il s'agit d'une valeur booléenne indiquant qu'il s'agit d'une tâche de sauvegarde parent (composite).

Type : booléen

Obligatoire : non

MessageCategory

Ce paramètre est le nombre de tâches pour la catégorie de message spécifiée.

Les exemples de chaînes peuvent inclure AccessDenied, SUCCESS, AGGREGATE_ALL et INVALIDPARAMETERS. Voir Surveillance pour une liste de MessageCategory chaînes.

La valeur ANY renvoie le nombre de toutes les catégories de messages.

AGGREGATE_ALL agrège le nombre de tâches pour toutes les catégories de messages et renvoie la somme.

Type : chaîne

Obligatoire : non

ParentJobId

Cela identifie de manière unique une demande vers AWS Backup pour sauvegarder une ressource. Le retour sera l'ID de tâche parent (composite).

Type : chaîne

Obligatoire : non

PercentDone

Contient une estimation du pourcentage d'achèvement d'une tâche au moment où le statut de la tâche a été demandé.

Type : chaîne

Obligatoire : non

RecoveryPointArn

Un ARN qui identifie de façon unique un point de récupération ; par exemple, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Type : chaîne

Obligatoire : non

RecoveryPointLifecycle

Spécifie la période, en jours, avant qu'un point de restauration ne passe en stockage à froid ou ne soit supprimé.

Les sauvegardes transférées vers un stockage à froid doivent être stockées dans le stockage à froid pendant au moins 90 jours. Par conséquent, sur la console, le paramètre de rétention doit être supérieur de 90 jours au réglage de transition vers le froid après plusieurs jours. Le paramètre de transition vers le froid après plusieurs jours ne peut pas être modifié une fois qu'une sauvegarde est passée au mode froid.

Les types de ressources pouvant passer au stockage à froid sont répertoriés dans le tableau Disponibilité des fonctionnalités par ressource. AWS Backup ignore cette expression pour les autres types de ressources.

Pour supprimer le cycle de vie et les périodes de rétention existants et conserver vos points de restauration indéfiniment, spécifiez -1 pour MoveToColdStorageAfterDays etDeleteAfterDays.

Type : objet Lifecycle

Obligatoire : non

ResourceArn

Un ARN qui identifie de façon unique une ressource. Le format de l'ARN dépend du type de ressource.

Type : chaîne

Obligatoire : non

ResourceName

Nom non unique de la ressource appartenant à la sauvegarde spécifiée.

Type : chaîne

Obligatoire : non

ResourceType

Type de AWS ressource à sauvegarder ; par exemple, un volume Amazon Elastic Block Store (Amazon EBS) ou une base de données Amazon Relational Database Service (Amazon RDS). Pour les sauvegardes Windows Volume Shadow Copy Service (VSS), le seul type de ressource pris en charge est Amazon EC2.

Type : String

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

Obligatoire : non

StartBy

Spécifie l'heure au format Unix et au format UTC (Coordinated Universal Time) quand une tâche de sauvegarde doit être démarrée avant d'être annulée. La valeur est calculée en ajoutant la fenêtre de démarrage à l'heure planifiée. Ainsi, si l'heure prévue était 18 h 00 et que la fenêtre de début était de 2 heures, l'heure StartBy serait 20 h 00 à la date spécifiée. La valeur de StartBy est précise en millisecondes. Par exemple, la valeur 1516925490,087 représente le vendredi 26 janvier 2018 à 00 h 11 m 30,087 s.

Type : Timestamp

Obligatoire : non

State

L'état actuel d'une tâche de sauvegarde.

Type : String

Valeurs valides : CREATED | PENDING | RUNNING | ABORTING | ABORTED | COMPLETED | FAILED | EXPIRED | PARTIAL

Obligatoire : non

StatusMessage

Message détaillé expliquant le statut de la tâche de sauvegarde d'une ressource.

Type : chaîne

Obligatoire : non

VaultLockState

État de verrouillage du coffre-fort de sauvegarde. Pour les coffres-forts à espacement logique, cela indique si le coffre-fort est verrouillé en mode de conformité. Les valeurs valides sont LOCKED et UNLOCKED.

Type : chaîne

Obligatoire : non

VaultType

Type de coffre-fort de sauvegarde dans lequel le point de restauration est stocké. Les valeurs valides concernent BACKUP_VAULT les coffres-forts de sauvegarde standard et les coffres-forts LOGICALLY_AIR_GAPPED_BACKUP_VAULT à espacement logique.

Type : chaîne

Obligatoire : non

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :