ModifyDBCluster

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

Restricciones:

Tipo: cadena

Obligatorio: sí

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

Restricciones: debe permitir la actualización 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 de base de datos.

Tipo: Booleano

Obligatorio: no

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.

Valor predeterminado: false

Tipo: Booleano

Obligatorio: no

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:

Tipo: entero

Obligatorio: no

El ajuste de configuración de los tipos de registro que se van a habilitar para la exportación a Amazon CloudWatch Logs para una instancia o un clúster específicos. Las DisableLogTypes matrices EnableLogTypes y determinan qué registros se exportan (o no se exportan) a CloudWatch Logs.

Tipo: objeto CloudwatchLogsExportConfiguration

Obligatorio: no

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

Tipo: cadena

Requerido: no

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

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

Especifica si se debe gestionar la contraseña del usuario maestro con Amazon Web Services Secrets Manager. Si el clúster no administra la contraseña del usuario maestro con Amazon Web Services Secrets Manager, puede activar esta administración. En este caso, no puede especificarlaMasterUserPassword. Si el clúster ya administra la contraseña del usuario maestro con Amazon Web Services Secrets Manager y usted especifica que la contraseña del usuario maestro no se administre con Amazon Web Services Secrets Manager, debe especificarloMasterUserPassword. 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

La contraseña del usuario de la base de datos maestra. Esta contraseña puede contener cualquier ASCII carácter imprimible, excepto la barra diagonal (/), las comillas dobles («) o el símbolo «at» (@).

Limitaciones: debe contener de 8 a 100 caracteres.

Tipo: cadena

Requerido: no

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

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

El identificador de KMS clave de Amazon Web Services es la claveARN, el identificador de clave, el alias ARN o el nombre de alias de la KMS clave. Para usar una KMS clave en otra cuenta de Amazon Web Services, especifique la clave ARN o el aliasARN.

Hay una KMS clave predeterminada para su cuenta de Amazon Web Services. Su cuenta de Amazon Web Services tiene una KMS clave predeterminada diferente para cada región de Amazon Web Services.

Tipo: cadena

Requerido: no

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:

Ejemplo: my-cluster2

Tipo: cadena

Requerido: no

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

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.

La opción predeterminada es un período de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno Región de AWS.

Restricciones:

Tipo: cadena

Requerido: no

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

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

El valor predeterminado es un período de 30 minutos seleccionado al azar de un bloque de tiempo de 8 horas para cada uno de ellos Región de AWS, que se produce en un día aleatorio de la semana.

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

Restricciones: plazo mínimo de 30 minutos.

Tipo: cadena

Requerido: no

Especifica si se debe rotar el secreto gestionado por Amazon Web Services Secrets Manager 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 Amazon Web Services Secrets Manager para el clúster. El valor secreto contiene la contraseña actualizada.

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

Tipo: Booleano

Obligatorio: no

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

Una lista de grupos de seguridad de nube privada virtual (VPC) a los que pertenecerá el clúster.

Tipo: matriz de cadenas

Obligatorio: no

Información detallada sobre un clúster.

Tipo: objeto DBCluster

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

HTTPCódigo de estado: 400

DBClusterIdentifier no hace referencia a un clúster existente.

HTTPCódigo de estado: 404

DBClusterParameterGroupName no hace referencia a un grupo de parámetros de clúster existente.

HTTPCódigo de estado: 404

DBSubnetGroupName no hace referencia a un grupo de subredes existente.

HTTPCódigo de estado: 404

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

HTTPCódigo de estado: 400

La instancia especificada no se encuentra en el estado disponible.

HTTPCódigo de estado: 400

El estado del grupo de seguridad no permite la eliminación.

HTTPCódigo de estado: 400

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

HTTPCódigo de estado: 400

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

HTTPCódigo de estado: 400

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

HTTPCódigo de estado: 400

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

HTTPCódigo de estado: 400