RestoreDBClusterFromSnapshot - Amazon DocumentDB

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.

RestoreDBClusterFromSnapshot

Crée un nouveau cluster à partir d'un instantané ou d'un instantané de cluster.

Si un instantané est spécifié, le cluster cible est créé à partir de l'instantané de base de données source avec une configuration et un groupe de sécurité par défaut.

Si un instantané de cluster est spécifié, le cluster cible est créé à partir du point de restauration du cluster source avec la même configuration que le cluster de base de données source 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

Nom du cluster à créer à partir du cliché ou de l'instantané du cluster. Ce paramètre n'est pas sensible à la casse.

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 trait d'union ni contenir deux traits d'union consécutifs.

Exemple : my-snapshot-id

Type : chaîne

Obligatoire : oui

Engine

Le moteur de base de données à utiliser pour le nouveau cluster.

Par défaut : identique à la source.

Contrainte : Doit être compatible avec le moteur de la source.

Type : chaîne

Obligatoire : oui

SnapshotIdentifier

Identifiant de l'instantané ou de l'instantané de cluster à partir duquel effectuer la restauration.

Vous pouvez utiliser le nom ou l'Amazon Resource Name (ARN) pour spécifier un instantané de cluster. Cependant, vous pouvez uniquement utiliser l'ARN pour spécifier un instantané.

Contraintes :

  • Doit correspondre à l'identifiant d'un instantané existant.

Type : chaîne

Obligatoire : oui

AvailabilityZones. AvailabilityZoneN.

Fournit la liste des zones de disponibilité Amazon EC2 dans lesquelles les instances du cluster de base de données restauré peuvent être créées.

Type : tableau de chaînes

Obligatoire : non

DBClusterParameterGroupName

Nom du groupe de paramètres de cluster DB à associer à ce cluster DB.

Type : chaîne.       Nécessaire : Non

Si cet argument est omis, le groupe de paramètres du cluster de base de données par défaut est utilisé. S'il est fourni, il doit correspondre au nom d'un groupe de paramètres de cluster de base de données par défaut existant. La chaîne doit être composée de 1 à 255 lettres, chiffres ou tirets. Son premier caractère doit être une lettre et il ne peut pas se terminer par un tiret ni contenir deux tirets consécutifs.

Type : chaîne

Obligatoire : non

DBSubnetGroupName

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

EngineVersion

Version du moteur de base de données à utiliser pour le nouveau cluster.

Type : chaîne

Obligatoire : non

KmsKeyId

Identifiant de AWS KMS clé à utiliser lors de la restauration d'un cluster chiffré à partir d'un instantané de base de données ou d'un instantané de cluster.

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.

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

  • Si le cliché ou le cliché de cluster SnapshotIdentifier intégré est chiffré, le cluster restauré est chiffré à l'aide de la AWS KMS clé qui a été utilisée pour chiffrer le cliché ou le cliché de cluster.

  • Si le snapshot ou le snapshot du cluster n'SnapshotIdentifierest pas chiffré, le cluster de base de données restauré n'est pas chiffré.

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 : le même port que le cluster d'origine.

Type : entier

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

VpcSecurityGroupIds. VpcSecurityGroupIdN.

Liste des groupes de sécurité du cloud privé virtuel (VPC) auxquels le nouveau cluster appartiendra.

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

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

DBSnapshotNotFound

DBSnapshotIdentifierne fait pas référence à un instantané 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

DBSubnetGroupNotFoundFault

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

Code d’état HTTP : 404

InsufficientDBClusterCapacityFault

Le cluster ne dispose pas d'une capacité suffisante 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

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

StorageQuotaExceeded

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

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 AWS SDK spécifiques au langage, consultez les pages suivantes :