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 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
Requerido: 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 esfalse
, los cambios realizados en el clúster se aplican durante la siguiente ventana de mantenimiento.El parámetro
ApplyImmediately
solo afecta a los valoresNewDBClusterIdentifier
yMasterUserPassword
. Si ajusta el valor de este parámetro afalse
, los cambios en los valoresNewDBClusterIdentifier
yMasterUserPassword
se aplicarán durante la siguiente ventana de mantenimiento. Todas los demás cambios se aplican de inmediato, con independencia del valor del parámetroApplyImmediately
.Valor predeterminado:
false
Tipo: Booleano
Requerido: 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
Requerido: 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
yDisableLogTypes
determinan qué registros se exportarán (o no) a CloudWatch Logs.Tipo: objeto CloudwatchLogsExportConfiguration
Requerido: 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 yDeletionProtection
esté deshabilitado.DeletionProtection
protege los clústeres de una eliminación accidental.Tipo: Booleano
Requerido: 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
- 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
- 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
y65535
.Valor predeterminado: el mismo puerto que el clúster original.
Tipo: entero
Requerido: 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: plazo mínimo de 30 minutos.
Tipo: cadena
Requerido: 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
Requerido: 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
- 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: