RestoreDBClusterFromSnapshot
Crea un nuevo clúster desde una instantánea o una instantánea del clúster.
Si se especifica una instantánea, el clúster de destino se crea a partir de la instantánea de base de datos de origen con una configuración predeterminada y grupo de seguridad predeterminado.
Si se especifica una instantánea del clúster, el clúster de destino se crea a partir del clúster de origen con la misma configuración que el clúster de base de datos de origen 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 clúster que se va a crear a partir de la instantánea o de la instantánea del clúster. 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-snapshot-idTipo: cadena
Obligatorio: sí
-
- Engine
-
Motor que se va a usar para el clúster nuevo.
Predeterminado: igual que el de origen.
Restricción: debe ser compatible con el motor del origen.
Tipo: cadena
Obligatorio: sí
- SnapshotIdentifier
-
Identificador de la instantánea o instantánea del clúster desde la que se debe realizar la restauración.
Puede utilizar el nombre o el Nombre de recurso de Amazon (ARN) para especificar una instantánea del clúster. Sin embargo, puede utilizar únicamente el ARN para especificar una instantánea.
Restricciones:
-
Debe coincidir con el identificador de una instantánea existente.
Tipo: cadena
Obligatorio: sí
-
- AvailabilityZones.AvailabilityZone.N
-
Proporciona la lista de zonas de disponibilidad de Amazon EC2 donde se pueden crear las instancias del clúster de base de datos.
Tipo: matriz de cadenas
Obligatorio: no
- DBClusterParameterGroupName
-
El nombre del grupo de parámetros del clúster de base de datos que desea asociar a este clúster de base de datos.
Tipo: cadena. Obligatorio: no
Si se omite este argumento, se utiliza el grupo de parámetros de clúster de base de datos predeterminado. Si se suministra, debe coincidir con el nombre de un grupo de parámetros de clúster de base de datos predeterminado existente. La cadena debe contener de 1 a 255 caracteres, letras, números o guiones. El primer carácter debe ser una letra y no puede terminar con un guion o contener dos guiones seguidos.
Tipo: cadena
Requerido: no
- 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
DBSubnetGroupexistente.Ejemplo::
mySubnetgroupTipo: cadena
Requerido: no
- DeletionProtection
-
Especifica si se puede eliminar este clúster. Si
DeletionProtectionestá habilitado, no se puede eliminar el clúster a menos que se modifique yDeletionProtectionesté deshabilitado.DeletionProtectionprotege 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
- EngineVersion
-
La versión del motor que se va a usar para el clúster nuevo.
Tipo: cadena
Requerido: no
- KmsKeyId
-
El identificador de la clave de AWS KMS que se utiliza para restaurar un clúster cifrado a partir de una instantánea o un clúster.
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.
Si no se especifica un valor para el parámetro
KmsKeyId, ocurre lo siguiente:-
Si se cifra la instantánea o la instantánea de clúster en
SnapshotIdentifier, se cifra el clúster restaurado con la clave de AWS KMS que se utilizó para cifrar la instantánea o el clúster. -
Si la instantánea o el clúster de
SnapshotIdentifierno está cifrada, el clúster de base de datos restaurado no está cifrado.
Tipo: cadena
Requerido: no
-
- NetworkType
-
El tipo de red del clúster.
El tipo de red viene determinado por el
DBSubnetGroupespecificado para el clúster. UnDBSubnetGroupadmite 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|DUALTipo: 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
1150y65535.Valor predeterminado: el mismo puerto que el clúster original.
Tipo: entero
Obligatorio: 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 | iopt1El valor predeterminado es
standardTipo: cadena
Requerido: no
- Tags.Tag.N
-
Las etiquetas que se van a asignar al clúster restaurado.
Tipo: matriz de objetos Tag
Obligatorio: no
- VpcSecurityGroupIds.VpcSecurityGroupId.N
-
Una lista de grupos de seguridad de la nube privada virtual (VPC) a la que pertenecerá el nuevo clúster.
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
- 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
-
DBClusterSnapshotIdentifierno hace referencia a una instantánea de un clúster existente.Código de estado HTTP: 404
- DBSnapshotNotFound
-
DBSnapshotIdentifierno hace referencia a una instantánea existente.Código de estado HTTP: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupNameno hace referencia a un grupo de subredes existente.Código de estado HTTP: 404
- DBSubnetGroupNotFoundFault
-
DBSubnetGroupNameno 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
- 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
DBSubnetGroupni 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
- 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:
