CreateDBCluster - Amazon DocumentDB
Parámetros de la solicitudElementos de respuestaErroresVéase también

CreateDBCluster

Crea un nuevo clúster de Amazon DocumentDB.

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. Este parámetro 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-cluster

Tipo: cadena

Obligatorio: sí

Engine

El nombre del motor de base de datos que se debe utilizar para este clúster.

Valores válidos: docdb

Tipo: cadena

Obligatorio: sí

AvailabilityZones.AvailabilityZone.N

Una lista de zonas de disponibilidad de Amazon EC2 en las que se pueden crear instancias en el clúster.

Tipo: matriz de cadenas

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

DBClusterParameterGroupName

El nombre del grupo de parámetros del clúster para asociar a este clúster.

Tipo: cadena

Requerido: no

DBSubnetGroupName

Un grupo de subred con el que asociar este clúster.

Limitaciones: debe coincidir con el nombre de un DBSubnetGroup existente. No debe ser predeterminado.

Ejemplo: mySubnetgroup

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

Requerido: no

EnableCloudwatchLogsExports.member.N

La lista de tipos de registro que deben habilitarse para exportar a Registros de Amazon CloudWatch. Puede habilitar los registros de auditoría o los registros del generador de perfiles. Para obtener más información, consulte Auditoría de eventos de Amazon DocumentDB y Creación de perfiles de operaciones de Amazon DocumentDB.

Tipo: matriz de cadenas

Requerido: no

EngineVersion

El número de versión del motor de base de datos que se debe usar. --engine-version será el valor predeterminado de la última versión principal del motor. Para las cargas de trabajo de producción, se recomienda declarar explícitamente este parámetro con la versión del motor principal prevista.

Tipo: cadena

Requerido: no

GlobalClusterIdentifier

Identificador de clúster del nuevo clúster global.

Tipo: cadena

Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 255 caracteres.

Patrón: [A-Za-z][0-9A-Za-z-:._]*

Requerido: no

KmsKeyId

El identificador de la clave de AWS KMS de un clúster cifrado.

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á creando un clúster con la misma cuenta de la 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 una clave de cifrado en KmsKeyId:

  • Si el parámetro StorageEncrypted es true, Amazon DocumentDB utiliza la clave de cifrado predeterminada.

AWS KMS crea la clave de cifrado predeterminada para su Cuenta de AWS. Cada Cuenta de AWS dispone de una clave de cifrado predeterminada diferente para cada Regiones de AWS.

Tipo: cadena

Requerido: no

MasterUsername

Nombre del usuario maestro del clúster.

Restricciones:

  • Debe tener de 1 a 63 letras o números.

  • El primer carácter debe ser una letra.

  • No puede ser una palabra reservada para el motor de base de datos elegido.

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

Port

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

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

PreSignedUrl

No se admite actualmente.

Tipo: cadena

Requerido: no

StorageEncrypted

Especifica si el clúster está cifrado.

Tipo: Booleano

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

nota

Si crea un clúster de base de datos de DocumentDB con el tipo de almacenamiento establecido en iopt1, el tipo de almacenamiento aparece en la respuesta. El tipo de almacenamiento no se devuelve cuando se establece en standard.

Tipo: cadena

Requerido: no

Tags.Tag.N

Las etiquetas que se van a asignar al clúster.

Tipo: matriz de objetos Tag

Requerido: no

VpcSecurityGroupIds.VpcSecurityGroupId.N

Una lista de grupos de seguridad de VPC de EC2 para asociar a este 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

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

DBInstanceNotFound

DBInstanceIdentifier no hace referencia a una instancia existente.

Código de estado HTTP: 404

DBSubnetGroupDoesNotCoverEnoughAZs

Las subredes del grupo de subredes deben incluir al menos dos zonas de disponibilidad a menos que solo haya una zona de disponibilidad.

Código de estado HTTP: 400

DBSubnetGroupNotFoundFault

DBSubnetGroupName no hace referencia a un grupo de subredes existente.

Código de estado HTTP: 404

GlobalClusterNotFoundFault

GlobalClusterIdentifier no hace referencia a un clúster global existente.

Código de estado HTTP: 404

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

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

InvalidDBSubnetGroupStateFault

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

Código de estado HTTP: 400

InvalidGlobalClusterStateFault

La operación solicitada no se puede realizar mientras el clúster esté en este estado.

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

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: