RestoreDBClusterToPointInTime - Amazon DocumentDB

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

RestoreDBClusterToPointInTime

Restaura un clúster a un punto arbitrario en el tiempo. Los usuarios pueden restaurar a cualquier punto en el tiempo antes de LatestRestorableTime durante un máximo de BackupRetentionPeriod días. El clúster de destino se crea a partir del clúster de base de datos de origen con la misma configuración que el clúster original, salvo que el nuevo clúster se crea con el grupo de seguridad predeterminado.

Parámetros de la solicitud

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

DBClusterIdentifier

El nombre del nuevo clúster que se va a crear.

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.

Tipo: cadena

Obligatorio: sí

SourceDBClusterIdentifier

El identificador del clúster de origen desde el que se va a restaurar.

Restricciones:

  • Debe coincidir con el identificador de un DBCluster existente.

Tipo: cadena

Obligatorio: sí

DBSubnetGroupName

El nombre del grupo de subredes que se va a usar para el clúster nuevo.

Limitaciones: si se suministra, debe coincidir con el nombre de un DBSubnetGroup existente.

Ejemplo:: mySubnetgroup

Tipo: cadena

Requerido: no

DeletionProtection

Especifica si se puede eliminar este clúster. Si DeletionProtection está habilitado, no se puede eliminar el clúster a menos que se modifique y DeletionProtection esté deshabilitado. DeletionProtection protege los clústeres de una eliminación accidental.

Tipo: Booleano

Obligatorio: no

EnableCloudwatchLogsExports.member.N

La lista de tipos de registro que deben habilitarse para exportar a los registros de Amazon CloudWatch.

Tipo: matriz de cadenas

Obligatorio: no

KmsKeyId

El identificador de la clave de AWS KMS que se utiliza para restaurar un clúster cifrado a partir de un clúster cifrado.

El identificador de la clave de AWS KMS es el nombre de recurso de Amazon (ARN) de la clave de cifrado de AWS KMS. Si está restaurando un clúster con la misma Cuenta de AWS a la que pertenece la clave de cifrado de AWS KMS utilizada para cifrar el clúster nuevo, puede utilizar el alias de la clave de AWS KMS en lugar del ARN para la clave de cifrado de AWS KMS.

Puede restaurar a un nuevo clúster y cifrar el nuevo clúster con una clave de AWS KMS que es diferente de la clave de AWS KMS utilizada para cifrar el clúster de origen. El nuevo clúster de base de datos se cifra con la clave de AWS KMS identificada por el parámetro KmsKeyId.

Si no se especifica un valor para el parámetro KmsKeyId, ocurre lo siguiente:

  • Si el clúster está cifrado, el clúster restaurado se cifra usando la clave de AWS KMS que se usó para cifrar el clúster de origen.

  • Si el clúster no está cifrado, el clúster restaurado no estará cifrado.

Si DBClusterIdentifier se refiere a un clúster que no está cifrado, se rechaza la solicitud de restauración.

Tipo: cadena

Requerido: no

NetworkType

El tipo de red del clúster.

El tipo de red viene determinado por el DBSubnetGroup especificado para el clúster. Un DBSubnetGroup admite solamente el protocolo IPv4 o los protocolos IPv4 e IPv6 (DUAL).

Para obtener más información, consulte Clústeres de DocumentDB en una VPC en la Guía para desarrolladores de Amazon DocumentDB.

Valores válidos: IPV4 | DUAL

Tipo: cadena

Requerido: no

Port

El número de puerto en el que el nuevo clúster acepta las conexiones.

Restricciones: el valor debe estar entre 1150 y 65535.

Predeterminado: el puerto predeterminado para el motor.

Tipo: entero

Obligatorio: no

RestoreToTime

La fecha y la hora a la que se va a restaurar el clúster.

Valores válidos: una hora en formato de tiempo universal coordinado (UTC).

Restricciones:

  • Debe ser anterior a la última hora restaurable de la instancia.

  • Debe especificarse si no se proporciona el parámetro UseLatestRestorableTime.

  • No se puede especificar si el parámetro UseLatestRestorableTime es true.

  • No se puede especificar si el parámetro RestoreType es copy-on-write.

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

Tipo: marca temporal

Obligatorio: no

RestoreType

El tipo de restauración que se va a realizar. Puede especificar uno de los siguientes valores:

  • full-copy: el nuevo clúster de base de datos se restaura como una copia completa del clúster de la base de datos de origen.

  • copy-on-write: el nuevo clúster de base de datos se restaura como un clon del clúster de la base de datos de origen.

Restricciones: no puede especificar copy-on-write si la versión del motor del clúster de base de datos de origen es anterior a la 1.11.

Si no especifica un valor RestoreType, el nuevo clúster de base de datos se restaura como una copia completa del clúster de la base de datos de origen.

Tipo: cadena

Requerido: no

ServerlessV2ScalingConfiguration

Contiene la configuración de escalado de un clúster de Amazon DocumentDB sin servidor.

Tipo: objeto ServerlessV2ScalingConfiguration

Obligatorio: no

StorageType

El tipo de almacenamiento que se va a asociar al clúster de base de datos.

Para obtener información sobre los tipos de almacenamiento de los clústeres de Amazon DocumentDB, consulte Cluster storage configurations en la Guía para desarrolladores de Amazon DocumentDB.

Valores válidos para el tipo de almacenamiento: standard | iopt1

El valor predeterminado es standard

Tipo: cadena

Requerido: no

Tags.Tag.N

Las etiquetas que se van a asignar al clúster restaurado.

Tipo: matriz de objetos Tag

Obligatorio: no

UseLatestRestorableTime

Un valor que se establece en true para restaurar el clúster a la hora de la última copia de seguridad restaurable y false en caso contrario.

Predeterminado: false

Restricciones: no se puede especificar si se proporciona el parámetro RestoreToTime.

Tipo: Booleano

Obligatorio: no

VpcSecurityGroupIds.VpcSecurityGroupId.N

Una lista de grupos de seguridad de VPC a los que pertenece el clúster nuevo.

Tipo: matriz de cadenas

Obligatorio: no

Elementos de respuesta

El servicio devuelve el siguiente elemento.

DBCluster

Información detallada sobre un clúster.

Tipo: objeto DBCluster

Errores

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

DBClusterAlreadyExistsFault

El usuario ya tiene un clúster con el identificador concreto.

Código de estado HTTP: 400

DBClusterNotFoundFault

DBClusterIdentifier no hace referencia a un clúster existente.

Código de estado HTTP: 404

DBClusterQuotaExceededFault

No se puede crear el clúster porque ha alcanzado la cuota de clústeres máxima permitida.

Código de estado HTTP: 403

DBClusterSnapshotNotFoundFault

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

Código de estado HTTP: 404

DBSubnetGroupNotFoundFault

DBSubnetGroupName no hace referencia a un grupo de subredes existente.

Código de estado HTTP: 404

InsufficientDBClusterCapacityFault

El clúster no tiene capacidad suficiente para la operación actual.

Código de estado HTTP: 403

InsufficientStorageClusterCapacity

No hay bastante almacenamiento disponible para la acción en curso. Es posible que pueda resolver este error mediante la actualización de su grupo de subredes para utilizar diferentes zonas de disponibilidad que tienen más almacenamiento disponible.

Código de estado HTTP: 400

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

InvalidDBSnapshotState

El estado de la instantánea no permite la eliminación.

Código de estado HTTP: 400

InvalidRestoreFault

No puede restaurar desde una copia de seguridad de una nube privada virtual (VPC) a una instancia de base de datos que no sea de VPC.

Código de estado HTTP: 400

InvalidSubnet

La subred solicitada no es válida o se solicitaron varias subredes que no están en la misma nube privada virtual (VPC).

Código de estado HTTP: 400

InvalidVPCNetworkStateFault

El grupo de subredes no cubre todas las zonas de disponibilidad después de crearla, debido a los cambios realizados.

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

NetworkTypeNotSupported

El tipo de red no es compatible con DBSubnetGroup ni con la versión del motor de base de datos.

Código de estado HTTP: 400

StorageQuotaExceeded

La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.

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: