CopyDBClusterSnapshot - 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.

CopyDBClusterSnapshot

Copie un instantané d'un cluster.

Pour copier un instantané de cluster à partir d'un instantané de cluster manuel partagé, SourceDBClusterSnapshotIdentifier il doit s'agir du nom de ressource Amazon (ARN) de l'instantané de cluster partagé. Vous ne pouvez copier qu'un instantané de cluster de bases de données partagé, chiffré ou non, dans la même Région AWS.

Pour annuler l'opération de copie une fois qu'elle est en cours, supprimez le cliché du cluster cible identifié TargetDBClusterSnapshotIdentifier alors que cet instantané de cluster est en état de copie.

Paramètres de demande

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

SourceDBClusterSnapshotIdentifier

L'identifiant de l'instantané du cluster à copier. Ce paramètre n'est pas sensible à la casse.

Contraintes :

  • Vous devez spécifier un instantané système valide à l'état disponible.

  • Si le cliché source est Région AWS identique à la copie, spécifiez un identifiant de cliché valide.

  • Si l'instantané source se trouve dans un emplacement différent Région AWS de celui de la copie, spécifiez un ARN de capture de cluster valide.

Exemple : my-cluster-snapshot1

Type : chaîne

Obligatoire : oui

TargetDBClusterSnapshotIdentifier

L'identifiant du nouvel instantané du cluster à créer à partir de l'instantané du cluster source. 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-cluster-snapshot2

Type : chaîne

Obligatoire : oui

CopyTags

Définissez sur true pour copier toutes les balises de l'instantané du cluster source vers le cliché du cluster cible, et sinonfalse. L’argument par défaut est false.

Type : booléen

Obligatoire : non

KmsKeyId

ID de AWS KMS clé pour un instantané de cluster chiffré. L'ID de AWS KMS clé est le Amazon Resource Name (ARN), AWS KMS l'identifiant de AWS KMS clé ou l'alias de clé de AWS KMS chiffrement.

Si vous copiez un instantané de cluster chiffré depuis votre Compte AWS, vous pouvez spécifier une valeur KmsKeyId pour chiffrer la copie avec une nouvelle clé de AWS KMS chiffrement. Si vous ne spécifiez aucune valeur pourKmsKeyId, la copie du cliché de cluster est chiffrée avec la même AWS KMS clé que l'instantané de cluster source.

Si vous copiez un instantané de cluster chiffré partagé depuis un autre Compte AWS, vous devez spécifier une valeur pourKmsKeyId.

Pour copier un instantané de cluster chiffré vers un autre Région AWS, définissez KmsKeyId l'ID de AWS KMS clé que vous souhaitez utiliser pour chiffrer la copie de l'instantané de cluster dans la région de destination. AWS KMS les clés de chiffrement sont spécifiques à Région AWS celle dans laquelle elles ont été créées, et vous ne pouvez pas utiliser les clés de chiffrement les unes Région AWS des autres Région AWS.

Si vous copiez un instantané de cluster non chiffré et que vous spécifiez une valeur pour le KmsKeyId paramètre, une erreur est renvoyée.

Type : chaîne

Obligatoire : non

PreSignedUrl

L'URL qui contient une demande signée Signature Version 4 pour l'action d'CopyDBClusterSnapshotAPI dans Région AWS laquelle figure l'instantané du cluster source à copier. Vous devez utiliser le PreSignedUrl paramètre lorsque vous copiez un instantané de cluster à partir d'un autre Région AWS.

Si vous utilisez un outil AWS SDK ou le AWS CLI, vous pouvez le spécifier SourceRegion (ou --source-region pour le AWS CLI) au lieu de le spécifier PreSignedUrl manuellement. La spécification SourceRegion génère automatiquement une URL pré-signée qui est une demande valide pour l'opération pouvant être exécutée dans la source. Région AWS

L'URL présignée doit être une demande valide pour l'action d'CopyDBClusterSnapshotAPI qui peut être exécutée dans la source Région AWS contenant l'instantané du cluster à copier. La demande d'URL pré-signée doit contenir les valeurs de paramètres suivantes :

  • SourceRegion- L'ID de la région qui contient le cliché à copier.

  • SourceDBClusterSnapshotIdentifier- L'identifiant de l'instantané du cluster chiffré à copier. Cet identifiant doit être au format Amazon Resource Name (ARN) pour la Région AWS source. Par exemple, si vous copiez un instantané de cluster chiffré à partir de l' Région AWS us-east-1, cela ressemble à ce qui SourceDBClusterSnapshotIdentifier suit : arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot

  • TargetDBClusterSnapshotIdentifier- L'identifiant du nouvel instantané du cluster à créer. Ce paramètre n'est pas sensible à la casse.

Type : chaîne

Obligatoire : non

Étiquettes.Tag.N

Les balises à attribuer à l'instantané du cluster.

Type : tableau d’objets Tag

Obligatoire : non

Éléments de réponse

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

DBClusterSnapshot

Informations détaillées sur un instantané de cluster.

Type : objet DBClusterSnapshot

Erreurs

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

DBClusterSnapshotAlreadyExistsFault

Vous disposez déjà d'un instantané du cluster avec l'identifiant indiqué.

Code d’état HTTP : 400

DBClusterSnapshotNotFoundFault

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

Code d’état HTTP : 404

InvalidDBClusterSnapshotStateFault

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

Code d’état HTTP : 400

InvalidDBClusterStateFault

Le cluster n'est pas dans un état valide.

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

SnapshotQuotaExceeded

La demande vous obligerait à dépasser le nombre autorisé de clichés.

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 :