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.
ModifyDBInstance
Modifica la configuración de una instancia. Puede cambiar uno o varios parámetros de configuración de la base de datos mediante la especificación de estos parámetros y los nuevos valores en la solicitud.
Parámetros de la solicitud
Para obtener información sobre los parámetros comunes a todas las acciones, consulte Parámetros comunes.
- DBInstanceIdentifier
-
El identificador de instancias. Este valor se almacena como una cadena en minúsculas.
Restricciones:
-
Debe coincidir con el identificador de un
DBInstanceexistente.
Tipo: cadena
Obligatorio: sí
-
- ApplyImmediately
-
Especifica si las modificaciones de esta solicitud y todas las modificaciones pendientes se aplican de manera asíncrona en cuanto es posible, independientemente de la configuración de
PreferredMaintenanceWindowde esta instancia.Si este parámetro se establece en
false, los cambios realizados en la instancia se aplican durante la siguiente ventana de mantenimiento. Algunos cambios de los parámetros pueden causar una interrupción y se aplican en el siguiente reinicio por error.Valor predeterminado:
falseTipo: Booleano
Obligatorio: no
- AutoMinorVersionUpgrade
-
Este parámetro no se aplica a Amazon DocumentDB. Amazon DocumentDB no actualiza versiones secundarias, independientemente del valor establecido.
Tipo: Booleano
Obligatorio: no
- CACertificateIdentifier
-
Indica el certificado que debe asociarse a la instancia.
Tipo: cadena
Requerido: no
- CertificateRotationRestart
-
Especifica si la instancia de base de datos se reinicia cuando el usuario rota el certificado SSL/TLS.
Por defecto, la instancia de base de datos se reinicia cuando usted rota su certificado SSL/TLS. El certificado no se actualiza hasta que se reinicia la instancia de base de datos.
importante
Establezca este parámetro solo si no utiliza SSL/TLS para conectarse a la instancia de base de datos.
Si utiliza SSL/TLS para conectarse a la instancia de base de datos, consulte Cómo actualizar sus certificados de Amazon DocumentDB TLS y Cómo cifrar datos en tránsito en la Guía para desarrolladores de Amazon DocumentDB.
Tipo: Booleano
Obligatorio: no
- CopyTagsToSnapshot
-
Es un valor que indica si se deben copiar todas las etiquetas de la instancia de base de datos en instantáneas de la instancia de base de datos. Las etiquetas no se copian de forma predeterminada.
Tipo: Booleano
Obligatorio: no
- DBInstanceClass
-
La nueva capacidad de memoria e informática de la instancia (por ejemplo,
db.r5.large). No todas las clases de instancia están disponibles en todas las Regiones de AWS.Si modifica la clase de la instancia se produce una interrupción durante el cambio. El cambio se aplica durante la siguiente ventana de mantenimiento, a menos que
ApplyImmediatelyse especifique comotruepara esta solicitud.Valor predeterminado: utiliza la configuración existente.
Tipo: cadena
Requerido: no
- EnablePerformanceInsights
-
Un valor que indica si se habilita Información sobre rendimiento para la instancia de base de datos. Para obtener más información, consulte Uso de Información sobre rendimiento de Amazon.
Tipo: Booleano
Obligatorio: no
- NewDBInstanceIdentifier
-
El nuevo identificador de instancia para la instancia cuando se cambia el nombre de una instancia. Al cambiar el identificador de la instancia, la instancia se reiniciará inmediatamente si
Apply Immediatelyse configura entrue. Se produce durante el siguiente periodo de mantenimiento siApply Immediatelyse configura enfalse. Este valor se almacena como una cadena en 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:
mydbinstanceTipo: cadena
Requerido: no
-
- PerformanceInsightsKMSKeyId
-
El identificador AWS KMS clave para el cifrado de los datos de Performance Insights.
El identificador de AWS KMS clave es el ARN de clave, el identificador de clave, el ARN de alias o el nombre de alias de la clave KMS.
Si no especifica un valor para PerformanceInsights KMSKeyId, Amazon DocumentDB utilizará la clave de KMS predeterminada. Existe una clave KMS predeterminada para su cuenta de Amazon Web Services. La cuenta de Amazon Web Services tiene una clave de KMS predeterminada diferente para cada región de Amazon Web Services.
Tipo: cadena
Requerido: no
- PreferredMaintenanceWindow
-
El intervalo de tiempo semanal (en UTC) durante el cual puede llevarse a cabo el mantenimiento del sistema, que puede producir una interrupción. El cambio de este parámetro no produce una interrupción, salvo en la siguiente situación, y el cambio se aplica de forma asíncrona tan pronto como sea posible. Si hay acciones pendientes que provocan un reinicio, y el periodo de mantenimiento se cambia para incluir la hora actual, cambiar este parámetro provoca un reinicio de la instancia. Si traslada esta ventana a la hora actual, debe haber al menos 30 minutos entre la hora actual y el final de la ventana para garantizar que se apliquen los cambios pendientes.
Valor predeterminado: utiliza la configuración existente.
Formato:
ddd:hh24:mi-ddd:hh24:miDías válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo
Restricciones: debe durar al menos 30 minutos.
Tipo: cadena
Requerido: no
- PromotionTier
-
Valor que especifica el orden en el que se promueve una réplica de Amazon DocumentDB a la instancia primaria tras un fallo de la instancia primaria existente.
Valor predeterminado: 1
Valores válidos: 0-15
Tipo: entero
Obligatorio: no
Elementos de respuesta
El servicio devuelve el siguiente elemento.
- DBInstance
-
Información detallada sobre una instancia.
Tipo: objeto DBInstance
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AuthorizationNotFound
-
La IP CIDR o el grupo de seguridad de Amazon EC2 especificados no están autorizados para el grupo de seguridad especificado.
Es posible que Amazon DocumentDB tampoco esté autorizado para realizar las acciones necesarias en su nombre mediante IAM.
Código de estado HTTP: 404
- CertificateNotFound
-
CertificateIdentifierno hace referencia a un certificado existente.Código de estado HTTP: 404
- DBInstanceAlreadyExists
-
Ya tiene una instancia con el identificador dado.
Código de estado HTTP: 400
- DBInstanceNotFound
-
DBInstanceIdentifierno hace referencia a una instancia existente.Código de estado HTTP: 404
- DBParameterGroupNotFound
-
DBParameterGroupNameno hace referencia a un grupo de parámetros existente.Código de estado HTTP: 404
- DBSecurityGroupNotFound
-
DBSecurityGroupNameno hace referencia a un grupo de seguridad existente.Código de estado HTTP: 404
- DBUpgradeDependencyFailure
-
La actualización falló porque un recurso del que depende no puede ser modificado.
Código de estado HTTP: 400
- InsufficientDBInstanceCapacity
-
La clase de instancia especificada no está disponible en la zona de disponibilidad especificada.
Código de estado HTTP: 400
- InvalidDBInstanceState
-
La instancia especificada no se encuentra en el estado disponible.
Código de estado HTTP: 400
- InvalidDBSecurityGroupState
-
El estado del grupo de seguridad no permite la eliminación.
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
- StorageQuotaExceeded
-
La solicitud provocaría que superara la cantidad permitida de almacenamiento disponible en todas las instancias.
Código de estado HTTP: 400
- StorageTypeNotSupported
-
El almacenamiento del
StorageTypeespecificado no puede asociarse a la instancia de base de datos.Código de estado HTTP: 400
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulte lo siguiente:
