ModifyDBCluster

Modifica un ajuste para un clúster de Amazon DocumentDB. 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.

DBClusterIdentifier

El identificador del clúster que se está modificando. Este parámetro no distingue entre mayúsculas y minúsculas.

Restricciones:

• Debe coincidir con el identificador de un DBCluster existente.

Tipo: cadena

Obligatorio: sí

AllowMajorVersionUpgrade

Es un valor que indica si se permiten actualizaciones de las versiones principales.

Restricciones:

• Debe permitir las actualizaciones de la versión principal cuando especifique un valor para el parámetro EngineVersion que sea una versión principal diferente a la versión actual del clúster.

• Dado que algunos parámetros son específicos de la versión, cambiarlos requiere ejecutar una nueva llamada a la API ModifyDBCluster una vez que se complete la MVU local.

nota

La ejecución de una MVU afecta directamente los siguientes parámetros:

• MasterUserPassword

• NewDBClusterIdentifier

• VpcSecurityGroupIds

• Port

Tipo: Booleano

Obligatorio: no

ApplyImmediately

Un valor que especifica si los cambios de esta solicitud y todos los cambios pendientes se asignan de manera asincrónica en cuanto sea posible, independientemente del valor de PreferredMaintenanceWindow del clúster. Si este parámetro es false, los cambios realizados en el clúster se aplican durante la siguiente ventana de mantenimiento.

El parámetro ApplyImmediately solo afecta a los valores NewDBClusterIdentifier y MasterUserPassword. Si ajusta el valor de este parámetro a false, los cambios en los valores NewDBClusterIdentifier y MasterUserPassword se aplicarán durante la siguiente ventana de mantenimiento. Todas los demás cambios se aplican de inmediato, con independencia del valor del parámetro ApplyImmediately.

Predeterminado: false

Tipo: Booleano

Obligatorio: no

BackupRetentionPeriod

El número de días durante los que se retienen las copias de seguridad automatizadas. Debe especificar un valor mínimo de 1.

Valor predeterminado: 1

Restricciones:

• Debe ser un valor entre 1 y 35.

Tipo: entero

Obligatorio: no

CloudwatchLogsExportConfiguration

La opción de configuración para los tipos de registro que se debe habilitar para la exportación a Registros de Amazon CloudWatch para una instancia o un clúster específico. Las matrices EnableLogTypes y DisableLogTypes determinan qué registros se exportarán (o no) a CloudWatch Logs.

Tipo: objeto CloudwatchLogsExportConfiguration

Obligatorio: no

DBClusterParameterGroupName

El nombre del grupo de parámetros de clúster que se va a usar para el clúster.

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

EngineVersion

El número de versión del motor de base de datos al que desea realizar la actualización. El cambio de este parámetro produce una interrupción. El cambio se aplica durante la siguiente ventana de mantenimiento a menos que ApplyImmediately esté activado.

Para listar todas las versiones de motor disponibles para Amazon DocumentDB utilice el siguiente comando:

aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"

Tipo: cadena

Requerido: no

ManageMasterUserPassword

Especifica si se debe administrar la contraseña del usuario maestro con Secrets Manager de Amazon Web Services. Si el clúster no administra la contraseña del usuario maestro con Secrets Manager de Amazon Web Services, puede activar esta administración. En este caso, no puede especificar MasterUserPassword. Si el clúster ya administra la contraseña del usuario maestro con Secrets Manager de Amazon Web Services y usted especifica que la contraseña del usuario maestro no se administre con Secrets Manager de Amazon Web Services, debe especificar MasterUserPassword. En este caso, Amazon DocumentDB elimina el secreto y utiliza la nueva contraseña para el usuario maestro especificado por MasterUserPassword.

Tipo: Booleano

Obligatorio: no

MasterUserPassword

La contraseña del usuario de la base de datos maestra. Esta contraseña puede contener cualquier carácter ASCII imprimible, excepto barra inclinada (/), comillas dobles (") o el símbolo de “arroba” (@).

Limitaciones: debe contener de 8 a 100 caracteres.

Tipo: cadena

Requerido: no

MasterUserSecretKmsKeyId

El identificador de clave KMS de Amazon Web Services para cifrar un secreto que se genera y administra automáticamente en Secrets Manager de Amazon Web Services.

Esta configuración es válida solamente si se cumplen las siguientes dos condiciones:

• Si el clúster no administra la contraseña del usuario maestro con Secrets Manager de Amazon Web Services. Si el clúster ya administra la contraseña de usuario maestro en Secrets Manager de Amazon Web Services, no podrá cambiar la clave de KMS que se usa para cifrar el secreto.

• Está habilitando ManageMasterUserPassword para que administre la contraseña de usuario maestro en Secrets Manager de Amazon Web Services. Si activa ManageMasterUserPassword y no especifica el MasterUserSecretKmsKeyId, se utilizará la clave de KMS de aws/secretsmanager para cifrar el secreto. Si el secreto está en una cuenta de Amazon Web Services diferente, entonces no puede usar la clave de KMS de aws/secretsmanager para cifrar el secreto y se debe usar una clave de KMS administrada por el cliente.

El identificador de la clave de KMS de Amazon Web Services es el ARN de la clave, el identificador de clave, el ARN de alias o el nombre de alias de la clave de KMS. Para utilizar una clave de KMS en una cuenta de Amazon Web Services diferente, debe especificar el ARN de la clave o el ARN del alias.

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

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

NewDBClusterIdentifier

El nuevo identificador del clúster cuando se cambia el nombre de un clúster. 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:: my-cluster2

Tipo: cadena

Requerido: no

Port

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

Restricciones: el valor debe estar entre 1150 y 65535.

Valor predeterminado: el mismo puerto que el clúster original.

Tipo: entero

Obligatorio: no

PreferredBackupWindow

El intervalo de tiempo diario durante el que se crean las copias de seguridad automatizadas si las copias de seguridad automatizadas están habilitadas con el parámetro BackupRetentionPeriod.

El valor predeterminado es una ventana de 30 minutos seleccionada al azar dentro de un bloque de 8 horas para cada Región de AWS.

Restricciones:

• Tiene que tener el formato hh24:mi-hh24:mi.

• Debe indicarse en Tiempo universal coordinado (UTC).

• No debe entrar en conflicto con la ventana de mantenimiento preferida.

• Debe durar al menos 30 minutos.

Tipo: cadena

Requerido: no

PreferredMaintenanceWindow

El intervalo de tiempo semanal durante el cual puede llevarse a cabo el mantenimiento del sistema, en tiempo universal coordinado (UTC).

Formato: ddd:hh24:mi-ddd:hh24:mi

El valor predeterminado es un periodo de 30 minutos seleccionado al azar de un bloque de 8 horas de tiempo para cada Región de AWS, que tiene lugar un día de la semana al azar.

Días válidos: lunes, martes, miércoles, jueves, viernes, sábado, domingo

Restricciones: ventana mínima de 30 minutos.

Tipo: cadena

Requerido: no

RotateMasterUserPassword

Especifica si se debe rotar el secreto administrado por Secrets Manager de Amazon Web Services para la contraseña del usuario maestro.

Esta configuración solo es válida si Amazon DocumentDB administra la contraseña del usuario maestro en Secrets Manager de Amazon Web Services para el clúster. El valor del secreto contiene la contraseña actualizada.

Restricción: debe aplicar el cambio inmediatamente cuando rota la contraseña del usuario maestro.

Tipo: Booleano

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 | iopt1

El valor predeterminado es standard

Tipo: cadena

Requerido: no

VpcSecurityGroupIds.VpcSecurityGroupId.N

Una lista de grupos de seguridad de la nube privada virtual (VPC) a la que pertenecerá el 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

DBClusterNotFoundFault

DBClusterIdentifier no hace referencia a un clúster existente.

Código de estado HTTP: 404

DBClusterParameterGroupNotFound

DBClusterParameterGroupName no hace referencia a un grupo de parámetros de 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

InvalidDBClusterStateFault

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

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

InvalidDBSubnetGroupStateFault

El grupo de subredes no se puede eliminar porque está en uso.

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

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:

• Interfaz de la línea de comandos de AWS, versión 2

• AWS SDK de para .NET

• AWS SDK para C++

• AWS SDK para Go v2

• AWS SDK para Java V2

• AWS SDK para JavaScript V3

• AWS SDK de para Kotlin

• AWS SDK de para PHP V3

• AWS SDK de para Python

• AWS SDK para Ruby V3