CopyDBClusterSnapshot - Amazon DocumentDB

CopyDBClusterSnapshot

Copia una instantánea de un clúster.

Para copiar una instantánea del clúster de una instantánea manual del clúster compartida, SourceDBClusterSnapshotIdentifier debe ser el Nombre de recurso de Amazon (ARN) de la instantánea del clúster compartida. Solo puede copiar una instantánea de clúster de base de datos compartidos, cifrada o no, en la misma Región de AWS.

Para cancelar la operación de copia después de que esté en curso, elimine la instantánea de clúster de destino identificada por TargetDBClusterSnapshotIdentifier mientras esa instantánea de clúster está en estado de copia.

Parámetros de la solicitud

Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.

SourceDBClusterSnapshotIdentifier

El identificador de la instantánea del clúster que se va a copiar. Este parámetro no distingue entre mayúsculas y minúsculas.

Restricciones:

  • Se debe especificar una instantánea del sistema válida cuyo estado sea available (disponible).

  • Si la instantánea de origen está en la misma Región de AWS que la copia, especifique un identificador de instantánea válido.

  • Si la instantánea de origen está en una Región de AWS distinta de la copia, especifique un ARN de instantánea de clúster válida.

Ejemplo: my-cluster-snapshot1

Tipo: cadena

Obligatorio: sí

TargetDBClusterSnapshotIdentifier

El identificador de la nueva instantánea del clúster que se va a crear a partir de la instantánea del clúster de origen. Este parámetro no distingue entre mayúsculas y minúsculas.

Restricciones:

  • Deben contener de 1 a 63 caracteres (letras, números o guiones).

  • El primer carácter debe ser una letra.

  • No puede terminar por un guion ni contener dos guiones consecutivos.

Ejemplo: my-cluster-snapshot2

Tipo: cadena

Obligatorio: sí

CopyTags

Establezca a true para copiar todas las etiquetas de la instantánea del clúster de origen a la instantánea del clúster de destino, y en caso contrario false. El valor predeterminado es false.

Tipo: Booleano

Requerido: no

KmsKeyId

ID de la clave de AWS KMS de una instantánea del clúster de base de datos cifrada. El ID de clave de AWS KMS es el nombre de recurso de Amazon (ARN), el identificador de clave de AWS KMS o el alias de clave de AWS KMS de la clave de cifrado de AWS KMS.

Si copia una instantánea de clúster cifrada desde su Cuenta de AWS, puede especificar un valor KmsKeyId para cifrar la copia con una nueva clave de cifrado AWS KMS. Si no especifica ningún valor para KmsKeyId, la copia de la instantánea del clúster de base de datos se cifra con la misma clave de AWS KMS que la instantánea del clúster de origen.

Si copia una instantánea del clúster de base de datos cifrada que se ha compartido desde otra Cuenta de AWS, debe especificar un valor para KmsKeyId.

Para copiar una instantánea de un clúster cifrado en otra Región de AWS, establezca KmsKeyId en el identificador de la clave AWS KMS que va a usar para cifrar la copia de la instantánea de un clúster en la región de destino. Las claves de cifrado de AWS KMS son específicas para la Región de AWS en la que se han creado y no puede usar claves de cifrado de una Región de AWS en otra Región de AWS.

Si intenta copiar un snapshot de clúster de base de datos sin cifrar y especificar un valor para el parámetro KmsKeyId, se devuelve un error.

Tipo: cadena

Requerido: no

PreSignedUrl

La URL que contiene una solicitud firmada de Signature Version 4 para la operación CopyDBClusterSnapshot de la API en la Región de AWS que contiene la instantánea del clúster de origen que se desea copiar. Debe usar el parámetro PreSignedUrl al copiar una instantánea de un clúster de otra Región de AWS.

Si utiliza una herramienta del SDK de AWS o la AWS CLI, puede especificar la SourceRegion (o --source-region para la AWS CLI) en lugar de especificar PreSignedUrl manualmente. Especificando SourceRegion autogenerar una URL prefirmada que es una solicitud válida para la operación que se puede ejecutar en la fuente Región de AWS.

La URL prefirmada debe ser una solicitud válida para la operación de la API CopyDBClusterSnapshot que se pueda ejecutar en la Región de AWS de origen que contiene la instantánea del clúster que se va a copiar. La solicitud de la URL prefirmada debe contener los siguientes valores de parámetros:

  • SourceRegion: el identificador de la región que contiene la instantánea que se va a copiar.

  • SourceDBClusterSnapshotIdentifier: identificador de la instantánea del clúster cifrada que se va a copiar. Este identificador debe estar en el formato de Nombre de recurso de Amazon (ARN) para la Región de AWS de origen. Por ejemplo, si copia una instantánea de clúster cifrada de la región us-east-1 Región de AWS, el SourceDBClusterSnapshotIdentifier tendrá un aspecto similar al del siguiente ejemplo: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier: identificador de la instantánea del clúster que se va a copiar. Este parámetro no distingue entre mayúsculas y minúsculas.

Tipo: cadena

Requerido: no

Tags.Tag.N

Las etiquetas que se van a asignar a la instantánea del clúster.

Tipo: matriz de objetos Tag

Requerido: no

Elementos de respuesta

El servicio devuelve el siguiente elemento.

DBClusterSnapshot

Información detallada sobre una instantánea de un clúster.

Tipo: objeto DBClusterSnapshot

Errores

Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.

DBClusterSnapshotAlreadyExistsFault

El usuario ya tiene una instantánea del clúster con el identificador concreto.

Código de estado HTTP: 400

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier no hace referencia a una instantánea de un clúster existente.

Código de estado HTTP: 404

InvalidDBClusterSnapshotStateFault

El valor proporcionado no es un estado de instantánea de clúster válido.

Código de estado HTTP: 400

InvalidDBClusterStateFault

El clúster no se encuentra en un estado válido.

Código de estado HTTP: 400

KMSKeyNotAccessibleFault

Se ha producido un error al acceder a una clave de AWS KMS.

Código de estado HTTP: 400

SnapshotQuotaExceeded

La solicitud provocaría que superara el número de instantáneas permitido.

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un idioma específico, consulte: