RestoreDBClusterToPointInTime - Amazon DocumentDB
Paramètres de demandeÉléments de réponseErreursconsultez 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.

RestoreDBClusterToPointInTime

Restaure un cluster à un moment arbitraire. Les utilisateurs peuvent restaurer à tout moment avant LatestRestorableTime pendant BackupRetentionPeriod jours. Le cluster cible est créé à partir du cluster source avec la même configuration que le cluster d'origine, sauf que le nouveau cluster est créé avec le groupe de sécurité par défaut.

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

DBClusterIdentifier

Il faut créer le nom du nouveau cluster.

Contraintes:

  • Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.

  • Le premier caractère doit être une lettre.

  • Ne peut pas se terminer par un tiret ou contenir deux tirets consécutifs.

Type : String

Obligatoire : oui

SourceDBClusterIdentifier

L'identifiant du cluster source à partir duquel effectuer la restauration.

Contraintes:

  • Doit correspondre à l'identifiant d'un DBCluster existant.

Type : String

Obligatoire : oui

DBSubnetGroupName

Le nom du groupe de sous-réseaux à utiliser pour le nouveau cluster.

Contraintes : si indiqué, il doit correspondre au nom d'un existantDBSubnetGroup.

Exemple : mySubnetgroup

Type : chaîne

Obligatoire : non

DeletionProtection

Spécifie si ce cluster peut être supprimé. Si cette option DeletionProtection est activée, le cluster ne peut pas être supprimé sauf s'il DeletionProtection est modifié et désactivé. DeletionProtectionprotège les clusters contre la suppression accidentelle.

Type : booléen

Obligatoire : non

EnableCloudwatchLogsExports.membre.n

Liste des types de journaux qui doivent être activés pour être exportés vers Amazon CloudWatch Logs.

Type : tableau de chaînes

Obligatoire : non

KmsKeyId

Identifiant de AWS KMS clé à utiliser lors de la restauration d'un cluster chiffré à partir d'un cluster chiffré.

L'identifiant de AWS KMS clé est le Amazon Resource Name (ARN) de la clé de AWS KMS chiffrement. Si vous restaurez un cluster Compte AWS possédant la clé de AWS KMS chiffrement utilisée pour chiffrer le nouveau cluster, vous pouvez utiliser l'alias de AWS KMS clé au lieu de l'ARN pour la clé de AWS KMS chiffrement.

Vous pouvez effectuer une restauration sur un nouveau cluster et chiffrer le nouveau cluster avec une AWS KMS clé différente de celle utilisée pour chiffrer le cluster source. AWS KMS Le nouveau cluster de base de données est chiffré avec la AWS KMS clé identifiée par le KmsKeyId paramètre.

Si vous ne spécifiez pas de valeur pour le paramètre KmsKeyId :

  • Si le cluster est chiffré, le cluster restauré est chiffré à l'aide de la AWS KMS clé utilisée pour chiffrer le cluster source.

  • Si le cluster n'est pas chiffré, le cluster restauré n'est pas chiffré.

S'il s'DBClusterIdentifieragit d'un cluster non chiffré, la demande de restauration est rejetée.

Type : chaîne

Obligatoire : non

NetworkType

Type de réseau du cluster.

Le type de réseau est déterminé par le type DBSubnetGroup spécifié pour le cluster. A ne DBSubnetGroup peut prendre en charge que le IPv4 protocole ou les IPv6 protocoles IPv4 et (DUAL).

Pour plus d'informations, consultez la section Clusters DocumentDB dans un VPC dans le manuel Amazon DocumentDB Developer Guide.

Valeurs valides : IPV4 | DUAL

Type : chaîne

Obligatoire : non

Port

Numéro de port sur lequel le nouveau cluster accepte les connexions.

Contraintes : doit être une valeur comprise entre 1150 et65535.

Par défaut : port par défaut du moteur.

Type : entier

Obligatoire : non

RestoreToTime

La date et l'heure auxquelles restaurer le cluster.

Valeurs valides : une heure au format UTC (temps universel)

Contraintes:

  • Doit être antérieure à la dernière date de restauration de l'instance.

  • Cela doit être indiqué si le paramètre UseLatestRestorableTime n'est pas fourni.

  • Cela ne peut pas être spécifié lorsque le paramètre UseLatestRestorableTime est true.

  • Cela ne peut pas être spécifié lorsque le paramètre RestoreType est copy-on-write.

Exemple : 2015-03-07T23:45:00Z

Type : Timestamp

Obligatoire : non

RestoreType

Type de restauration à exécuter. Vous pouvez spécifier l’une des valeurs suivantes :

  • full-copy - Le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.

  • copy-on-write - Le nouveau cluster de base de données est restauré sous la forme d'un clone du cluster de base de données source.

Contraintes : vous ne pouvez pas spécifier copy-on-write si la version du moteur du cluster de base de données source est antérieure à la version 1.11.

Si vous ne spécifiez pas de valeur pour RestoreType, le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.

Type : chaîne

Obligatoire : non

ServerlessV2ScalingConfiguration

Contient la configuration de dimensionnement d'un cluster Amazon DocumentDB Serverless.

Type : objet ServerlessV2ScalingConfiguration

Obligatoire : non

StorageType

Type de stockage à associer au cluster de base de données.

Pour plus d'informations sur les types de stockage pour les clusters Amazon DocumentDB, consultez la section Configurations de stockage des clusters dans le manuel Amazon DocumentDB Developer Guide.

Valeurs valides pour le type de stockage - standard | iopt1

La valeur par défaut est standard

Type : chaîne

Obligatoire : non

Étiquettes.Tag.N

Les balises à attribuer au cluster restauré.

Type : tableau d’objets Tag

Obligatoire : non

UseLatestRestorableTime

Une valeur définie sur true pour restaurer le cluster à la dernière heure de sauvegarde restaurable, et sur false dans le cas contraire.

Par défaut : false

Contraintes : ne peut pas être spécifiée si le paramètre RestoreToTime est fourni.

Type : booléen

Obligatoire : non

VpcSecurityGroupIds. VpcSecurityGroupIdN.

Liste des groupes de sécurité VPC auxquels appartient le nouveau cluster.

Type : tableau de chaînes

Obligatoire : non

Éléments de réponse

L'élément suivant est renvoyé par le service.

DBCluster

Informations détaillées sur un cluster.

Type : objet DBCluster

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

DBClusterAlreadyExistsFault

Vous avez déjà un cluster avec l'identifiant indiqué.

Code d’état HTTP : 400

DBClusterNotFoundFault

DBClusterIdentifierne fait pas référence à un cluster existant.

Code d’état HTTP : 404

DBClusterQuotaExceededFault

Le cluster ne peut pas être créé car vous avez atteint le quota maximum autorisé de clusters.

Code d’état HTTP : 403

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifierne fait pas référence à un instantané de cluster existant.

Code d’état HTTP : 404

DBSubnetGroupNotFoundFault

DBSubnetGroupNamene fait pas référence à un groupe de sous-réseaux existant.

Code d’état HTTP : 404

InsufficientDBClusterCapacityFault

La capacité du cluster est insuffisante pour l'opération en cours.

Code d’état HTTP : 403

InsufficientStorageClusterCapacity

L'espace de stockage disponible est insuffisant pour l'action en cours. Vous pouvez peut-être résoudre cette erreur en mettant à jour votre groupe de sous-réseaux afin qu'il utilise différentes zones de disponibilité disposant d'un espace de stockage plus important.

Code d’état HTTP : 400

InvalidDBClusterSnapshotStateFault

La valeur fournie n'est pas un état de capture d'écran de cluster valide.

Code d’état HTTP : 400

InvalidDBClusterStateFault

L'état du cluster n'est pas valide.

Code d’état HTTP : 400

InvalidDBSnapshotState

L'état de l'instantané ne permet pas de le supprimer.

Code d’état HTTP : 400

InvalidRestoreFault

Vous ne pouvez pas effectuer de restauration à partir d'une sauvegarde de cloud privé virtuel (VPC) vers une instance de base de données non VPC.

Code d’état HTTP : 400

InvalidSubnet

Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux ont été demandés mais ils ne se trouvent pas tous dans un cloud privé virtuel (VPC) commun.

Code d’état HTTP : 400

InvalidVPCNetworkStateFault

Le groupe de sous-réseaux ne couvre pas toutes les zones de disponibilité après sa création en raison des modifications apportées.

Code d’état HTTP : 400

KMSKeyNotAccessibleFault

Une erreur s'est produite lors de l'accès à une AWS KMS clé.

Code d’état HTTP : 400

NetworkTypeNotSupported

Le type de réseau n'est pris en charge ni par DBSubnetGroup ni par la version du moteur de base de données.

Code d’état HTTP : 400

StorageQuotaExceeded

La demande vous obligerait à dépasser la quantité de stockage autorisée disponible sur toutes les instances.

Code d’état HTTP : 400

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 :