Docs Menu
Docs Home
/ /
/ / /

AtlasDeployment Recurso personalizado

Importante

Migración a clústeres flexibles

  • Atlas dejó obsoletos los clústeres M2 y M5 y las instancias sin servidor. Atlas ha migrado los clústeres M2 y M5 a clústeres Flex. Para las instancias sin servidor, Atlas determinó si migrar las instancias a clústeres gratuitos, clústeres Flex o clústeres dedicados según su uso y, posteriormente, migró las instancias sin servidor automáticamente. Para obtener más información, consulte Guía de migración de Flex en la documentación de Atlas.

  • Reemplace las referencias a spec.serverlessSpec con la configuración de spec.flexSpec.

  • El operador de Kubernetes de Atlas rechaza los nuevos AtlasDeployment recursos personalizados que definen spec.serverlessSpec. Solo se puede usar spec.serverlessSpec para administrar instancias Serverless existentes.

Importante

Acción necesaria para realizar cambios importantes con el operador Atlas Kubernetes 2.0

  • Con el operador 2.0 de Atlas Kubernetes, deploymentSpec reemplaza a advancedDeploymentSpec en el recurso personalizado AtlasDeployment. Debe actualizar su recurso personalizado AtlasDeployment de la siguiente manera:

    • Si usa advancedDeploymentSpec, renómbrelo a deploymentSpec. No necesita cambiar el formato.

    • Si utilizó deploymentSpec antes del operador Atlas Kubernetes,2.0 reescriba su AtlasDeployment recurso personalizado para que coincida con el formato utilizado en los ejemplos.

  • El operador de Kubernetes de Atlas utiliza Archivos de configuración de recursos personalizados para administrar la configuración de Atlas. A partir del Operador de 2.0 Kubernetes de Atlas, los recursos personalizados que elimine en Kubernetes ya no se eliminan en Atlas. En su lugar, el Operador de Kubernetes de Atlas simplemente deja de administrarlos. Por ejemplo, si elimina un AtlasProject Recurso Personalizado en Kubernetes, el Operador de Kubernetes de Atlas ya no elimina automáticamente el proyecto correspondiente de Atlas, lo que evita eliminaciones accidentales o inesperadas. Para obtener más información, incluido cómo revertir este comportamiento al valor predeterminado utilizado antes 2 del0 Operador de Kubernetes de Atlas.,2 0consulte Nuevo valor predeterminado: Protección contra eliminación en el Operador de Kubernetes de Atlas..

El recurso personalizado AtlasDeployment configura su clúster MongoDB o Flex en Atlas. Al crear el recurso personalizado AtlasDeployment, el operador de Kubernetes de Atlas intenta crear o actualizar un clúster o Flex en Atlas.

El operador Atlas Kubernetes realiza una de las siguientes acciones según los valores que especifique en el recurso personalizado AtlasDeployment:

  • Si especifica valores para los campos en spec.deploymentSpec, Atlas Kubernetes Operator utiliza el recurso de API de clústeres de Atlas para crear un nuevo clúster o actualizar uno existente.

  • Si especifica valores para los campos en spec.flexSpec, Atlas Kubernetes Operator utiliza el recurso de API de instancia Flex de Atlas para crear un nuevo clúster Flex o actualizar un clúster Flex existente.

Nota

No especifiques valores para los campos de spec.serverlessSpec porque las instancias sin servidor están en desuso. En su lugar, especifica campos en spec.flexSpec. Para obtener más información, consulta Migración a clústeres Flex.

La creación de un clúster Atlas de nivel gratuito lleva menos de 15 segundos.

Crear o actualizar un clúster Flex o un clúster Dedicado puede tardar hasta 10 minutos. Atlas Kubernetes Operator supervisa el proceso de actualización.

Puede ejecutar el siguiente comando para comprobar el estado:

kubectl get atlasdeployment -o yaml

El siguiente ejemplo muestra la sección de estado de un clúster que se está aprovisionando:

status:
conditions:
- lastTransitionTime: "2024-03-18T16:32:43Z"
status: "False"
type: ClusterReady
reason: ClusterCreating
message: Cluster is provisioning

El estado ClusterReady cambiará a True cuando el clúster o la instancia sin servidor estén listos.

El siguiente ejemplo muestra el recurso AtlasDeployment con un estado ClusterReady de True:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: my-atlas-cluster
namespace: mongodb-atlas-system
spec:
projectRef:
name: my-project
deploymentSpec:
name: test-cluster
tags:
- key: "environment"
value: "production"
replicationSpecs:
- zoneName: US-Zone
numShards: 3
regionConfigs:
- regionName: CENTRAL_US
providerName: GCP
backingProviderName: GCP
priority: 7
electableSpecs:
instanceSize: M10
nodeCount: 3
status:
conditions:
- lastTransitionTime: "2024-03-18T16:32:43Z"
status: "True"
type: Ready
- lastTransitionTime: "2024-03-18T16:32:43Z"
status: "True"
type: ClusterReady
connectionStrings:
standard: mongodb://test-cluster-shard-00-00.kpc8f.mongodb.net:27017,test-cluster-shard-00-01.kpc8f.mongodb.net:27017,test-cluster-shard-00-02.kpc8f.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-1gm1pv-shard-0
standardSrv: mongodb+srv://test-cluster.kpc8f.mongodb.net
mongoDBVersion: 6.0
mongoURIUpdated: "2024-03-12T12:21:41Z"
observedGeneration: 1
stateName: IDLE

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para escalar automáticamente clústeres multirregionales:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: test-cluster-name
namespace: mongodb-atlas-system
spec:
projectRef:
name: development
deploymentSpec:
clusterType: REPLICASET
name: service-name
tags:
- key: "environment"
value: "production"
backupEnabled: true
replicationSpecs:
- numShards: 1
regionConfigs:
- regionName: EASTERN_US
providerName: GCP
autoScaling:
diskGB:
enabled: true
compute:
enabled: true
scaleDownEnabled: true
minInstanceSize: M30
maxInstanceSize: M40
analyticsSpecs:
instanceSize: M30
nodeCount: 1
electableSpecs:
instanceSize: M30
nodeCount: 3
priority: 7
readOnlySpecs:
instanceSize: M30
nodeCount: 1

El siguiente ejemplo muestra una AtlasDeployment especificación de recurso personalizada configurada con algunas de las opciones adicionales.

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: my-atlas-cluster
spec:
projectRef:
name: my-project
deploymentSpec:
name: test-cluster
tags:
- key: "environment"
value: "production"
replicationSpecs:
- zoneName: Zone 1
regionConfigs:
- electableSpecs:
instanceSize: M10
nodeCount: 3
providerName: AWS
regionName: US_EAST_1
priority: 7
processArgs:
javascriptEnabled: false

Para administrar clústeres Flex, debe usar Atlas Kubernetes Operator 2.12.0 o una versión posterior. Esta es la primera versión sin dependencias de servidor.

  • Puede crear y administrar clústeres Flex utilizando el recurso personalizado AtlasDeployment.

  • Utilice spec.flexSpec en el recurso personalizado AtlasDeployment para configurar clústeres Flex.

  • M2Los clústeres /M5 y las instancias sin servidor ya no son compatibles. Todas las instancias existentes se han migrado a clústeres Flex u otros tipos de clústeres.

Para obtener más información, consulte Migración a clústeres Flex en esta guía y la Guía de migración a Flex en la documentación de Atlas.

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para un clúster Flex:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: test-cluster-name
namespace: mongodb-atlas-system
spec:
projectRef:
name: my-project
flexSpec:
name: flex-cluster
tags:
- key: "environment"
value: "production"
providerSettings:
backingProviderName: AWS
regionName: US_EAST_1

Nota

No especifiques valores para los campos de spec.serverlessSpec porque las instancias sin servidor están en desuso. En su lugar, especifica campos en spec.flexSpec. Para obtener más información, consulta Migración a clústeres Flex.

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para una instancia sin servidor:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: test-cluster-name
namespace: mongodb-atlas-system
spec:
projectRef:
name: development
serverlessSpec:
name: serverless-instance
tags:
- key: "environment"
value: "production"
providerSettings:
providerName: AWS
regionName: US_EAST_1

Los clústeres pueden abarcar regiones y proveedores de servicios en la nube. Para obtener más información, consulte Consideraciones.

Nota

Mientras que el recurso API del clúster Atlas envía solicitudes mediante el v1.5 Atlas Versiones de la API: el campo Operador de Atlas Kubernetes apiVersion v1usa. En este caso, v1 se refiere a la versión de la API de Kubernetes.

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para clústeres multirregionales:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: my-atlas-cluster
spec:
projectRef:
name: my-project
deploymentSpec:
clusterType: REPLICASET
name: tenantCluster
tags:
- key: "environment"
value: "production"
replicationSpecs:
- zoneName: Zone 1
regionConfigs:
priority: 7
- electableSpecs:
instanceSize: M10
nodeCount: 3
providerName: AWS
regionName: US_EAST_1

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para abarcar múltiples proveedores de servicios en la nube:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: my-atlas-cluster
spec:
projectRef:
name: my-project
deploymentSpec:
clusterType: REPLICASET
name: tenantCluster
tags:
- key: "environment"
value: "production"
replicationSpecs:
- regionConfigs:
- electableSpecs:
instanceSize: M10
nodeCount: 3
providerName: AWS
regionName: US_EAST_1
priority: 7
- electableSpecs:
instanceSize: M10
nodeCount: 2
providerName: AZURE
regionName: US_EAST_2
priority: 6
- electableSpecs:
instanceSize: M10
nodeCount: 2
providerName: GCP
regionName: CENTRAL_US
priority: 5

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para crear un índice de búsqueda para la colección listingsAndReviews y grades:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: my-atlas-cluster
namespace: mongodb-atlas-system
spec:
deploymentSpec:
backupEnabled: true
clusterType: REPLICASET
name: Test-cluster-M10
replicationSpecs:
- regionConfigs:
- backingProviderName: AWS
electableSpecs:
instanceSize: M10
nodeCount: 3
priority: 7
providerName: AWS
regionName: US_EAST_1
zoneName: Zone 1
searchIndexes:
- DBName: sample_training
collectionName: grades
name: test-vector-search-index
type: vectorSearch
vectorSearch:
fields:
- numDimensions: 1000
path: student_id
similarity: euclidean
type: vector
- DBName: sample_airbnb
collectionName: listingsAndReviews
name: my-index
search:
mappings:
dynamic: true
searchConfigurationRef:
name: atlassearchindexconfig-sample
namespace: mongodb-atlas-system
type: search
terminationProtectionEnabled: false
projectRef:
name: my-project
namespace: mongodb-atlas-system

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para crear nodos de búsqueda:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
name: my-atlas-cluster
namespace: mongodb-atlas-system
spec:
deploymentSpec:
backupEnabled: true
clusterType: REPLICASET
name: Test-cluster-M10
replicationSpecs:
- regionConfigs:
- backingProviderName: AWS
electableSpecs:
instanceSize: M10
nodeCount: 3
priority: 7
providerName: AWS
regionName: US_EAST_1
zoneName: Zone 1
searchNodes:
- instanceSize: S20_HIGHCPU_NVME
nodeCount: 2

AtlasDeployment es el esquema para la API de atlasdeployments

Name
Tipo
Descripción
Requerido

apiVersion

string

atlas.mongodb.com/v1

true

kind

string

AtlasDeployment

true

metadata

Objeto

Consulte la documentación de Kubernetes API para conocer los campos del campo metadata.

true

spec

Objeto

AtlasDeploymentSpec Define el estado objetivo de.AtlasDeployment Solo DeploymentSpec AdvancedDeploymentSpec ServerlessSpec se debe definir unode los siguientes:, y. Validaciones:

  • (has(self.``externalProjectRef``) && !has(self.``projectRef``)) || (!has(self.``externalProjectRef``) && has(self.``projectRef``)): debe definir solo una referencia de proyecto a través de externalProjectRef o projectRef

  • (has(self.``externalProjectRef``) && has(self.``connectionSecret``)) || !has(self.``externalProjectRef``): debe definir un secreto de conexión local al hacer referencia a un proyecto externo

  • !has(self.``serverlessSpec``) || (oldSelf.``hasValue``() && oldSelf.value().``serverlessSpec`` != null): No se puede agregar serverlessSpec: las instancias sin servidor están obsoletas

false

status

Objeto

AtlasDeploymentStatus define el estado observado de AtlasDeployment.

false

AtlasDeploymentSpec define el estado objetivo de AtlasDeployment. Solo se debe definir DeploymentSpec, AdvancedDeploymentSpec y ServerlessSpec.

Name
Tipo
Descripción
Requerido

backupRef

Objeto

Referencia a la programación de copias de seguridad para AtlasDeployment.

false

connectionSecret

Objeto

Nombre del secreto que contiene las claves privadas y públicas de Atlas API.

false

deploymentSpec

Objeto

Configuración para la implementación1.5 avanzada (v) API https://www.mongodb.com/es/docs/atlas/reference/api/clusters/

false

externalProjectRef

Objeto

externalProjectRef Contiene el proyecto Atlas principal ID. Se excluye mutuamente con el campo "projectRef".

false

flexSpec

Objeto

false

processArgs

Objeto

ProcessArgs permite la modificación de Opciones de Configuración Avanzadas.

false

projectRef

Objeto

projectRef Es una referencia al recurso principal AtlasProject. Se excluye mutuamente con el campo "externalProjectRef".

false

serverlessSpec

Objeto

false

upgradeToDedicated

booleano

upgradeToDedicatedCuando se establece como verdadero, se activa la migración de un clúster flexible a uno dedicado. El usuario MUST proporciona la nueva configuración del clúster dedicado. Este indicador se ignora si el clúster ya está dedicado.

false

Referencia al programa de copias de seguridad para AtlasDeployment.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Nombre del secreto que contiene las claves públicas y privadas de la API de Atlas.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso al que se hace referencia Más información: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

true

Configuración para la1.5 API de implementación avanzada (v) https://www.mongodb.com/es/docs/atlas/reference/api/clusters/

Name
Tipo
Descripción
Requerido

name

string

Nombre de la implementación avanzada tal como aparece en Atlas. Una vez que Atlas crea la implementación, no se puede cambiar su nombre. Solo puede contener ASCII letras, números y guiones. Validaciones:

  • self == oldSelf: El nombre no se puede modificar después de la creación de la implementación

true

backupEnabled

booleano

Marca que indica si la implementación utiliza copias de seguridad en la nube. Aplicable solo para implementaciones M10 o más.

false

biConnector

Objeto

Configuración del Conector BI para Atlas en esta implementación. El Conector MongoDB para Business Intelligence para Atlas (Conector BI) solo está disponible para implementaciones de M10 y superiores.

false

clusterType

enum

Tipo de implementación que desea crear. El parámetro es obligatorio si replicationSpecs se configura o si se implementan implementaciones globales. REPLICASETSHARDEDEnumeración:,, GEOSHARDED

false

configServerManagementMode

enum

Modo de administración del servidor de configuración para crear o actualizar un clúster fragmentado. ATLAS_MANAGEDEnumeración:, FIXED_TO_DEDICATED

false

customZoneMapping

[]objeto

Lista que contiene parámetros de clúster global que mapean zonas a regiones geográficas.

false

diskSizeGB

entero

Capacidad, en gigabytes, del volumen raíz del host. Aumente este número para añadir capacidad, hasta un valor máximo posible de 4096 (es4 TB decir,). Este valor debe ser un entero positivo. El parámetro es obligatorio si replicationSpecs se configura. Mínimo: 0 Máximo: 4096

false

encryptionAtRestProvider

enum

Proveedor de servicios enla nube que ofrece cifrado en reposo. AWS GCPEnumeración:,,, AZURENONE

false

labels

[]objeto

Colección de pares clave-valor que etiquetan y categorizan la implementación. Cada clave y su valor tienen una longitud máxima de 255 caracteres. DEPRECATED: Los clústeres labels se encuentran obsoletos y se eliminarán en una futura versión. Te recomendamos firmemente que uses etiquetas de recursos en su lugar.

false

managedNamespaces

[]objeto

Lista que contiene información para crear un espacio de nombres administrado en un clúster global específico para crear.

false

mongoDBMajorVersion

string

MongoDB Versión principal del clúster. Establezca la versión principal binaria.

false

mongoDBVersion

string

Versión de MongoDB que ejecuta el clúster.

false

paused

booleano

Bandera que indica si se debe pausar la implementación.

false

pitEnabled

booleano

Bandera que indica que la implementación utiliza copias de seguridad en la nube continuas.

false

replicationSpecs

[]objeto

Configuración para regiones de implementación.

false

rootCertType

string

Autoridad de certificación raíz que utiliza el clúster Atlas MongoDB.

false

searchIndexes

[]objeto

Una matriz de SearchIndex objetos con campos que describen el índice de búsqueda.

false

searchNodes

[]objeto

Configuración de los nodos de búsqueda del clúster. Actualmente, se puede definir como máximo una configuración de nodo de búsqueda.

false

tags

[]objeto

Pares clave-valor para etiquetado de recursos.

false

terminationProtectionEnabled

booleano

Marca que indica si la protección de terminación está habilitada en el clúster. Si se establece en "true", MongoDB Cloud no eliminará el clúster. Si se establece en "false", MongoDB Cloud eliminará el clúster. Predeterminado: "false"

false

versionReleaseSystem

string

Método mediante el cual el clúster mantiene las versiones MongoDB. Si el valor es CONTINUOUS, no debe especificar mongoDBMajorVersion.

false

Configuración del BI Connector para Atlas en esta implementación. El conector de MongoDB para Business Intelligence para Atlas (BI Connector) solo está disponible para implementaciones M10 y mayores.

Name
Tipo
Descripción
Requerido

enabled

booleano

Indicador que señala si el conector de Business Intelligence para Atlas está enabled en la implementación.

false

readPreference

string

Fuente de la que el Connector BI de Atlas lee datos. Cada preferencia de lectura del Connector BI de Atlas contiene una combinación distinta de opciones readPreference y readPreferenceTags.

false

Name
Tipo
Descripción
Requerido

location

string

Código que representa un location que se asigna a una zona en su clúster global. MongoDB Atlas representa este location con un ISO 3166-2 location y códigos de subdivisión cuando sea posible.

true

zone

string

Etiqueta legible que identifica el zone en tu clúster global. Este zone se asigna a un código de ubicación.

true

LabelSpec contiene pares clave-valor que etiquetan y categorizan el clúster/DBUser

Name
Tipo
Descripción
Requerido

key

string

Clave aplicada para etiquetar y categorizar este componente.

true

value

string

Valor establecido en la clave aplicada para etiquetar y categorizar este componente.

true

ManagedNamespace representa la información sobre la configuración del espacio de nombres administrado.

Name
Tipo
Descripción
Requerido

collection

string

Etiqueta legible por humanos del collection que se administrará para este clúster global.

true

db

string

Etiqueta legible por humanos de la base de datos que se administrará para este clúster global.

true

customShardKey

string

Parámetro de base de datos utilizado para dividir la colección en fragmentos. Los clústeres globales requieren una clave de fragmento compuesta. Esta clave de fragmento compuesta combina el parámetro de ubicación y la clave personalizada seleccionada por el usuario.

false

isCustomShardKeyHashed

booleano

Marca que indica si se ha generado un hash de la clave de fragmento personalizada para la colección especificada. Si se establece este valor como falso, MongoDB Cloud utiliza fragmentación por rango.

false

isShardKeyUnique

booleano

Indicador que indica si se ha generado un hash de la clave de fragmento personalizada. Si este parámetro devuelve "false", el clúster utiliza fragmentación por rango.

false

numInitialChunks

entero

Número mínimo de fragmentos que se deben crear inicialmente al fragmentar una colección vacía con una clave de fragmento con hash. El valor máximo es 8192.

false

presplitHashedZones

booleano

Bandera que indica si MongoDB Cloud debe crear y distribuir fragmentos iniciales para una colección vacía o inexistente. MongoDB Cloud distribuye datos según las zonas y los rangos de zonas definidos para la colección.

false

Name
Tipo
Descripción
Requerido

numShards

entero

Entero positivo que especifica la cantidad de fragmentos que se implementarán en cada zona especificada. Si establece este valor en 1 y clusterType es SHARDED, MongoDB Cloud implementa un clúster fragmentado de un solo fragmento. No cree un clúster fragmentado con un solo fragmento para entornos de producción. Los clústeres fragmentados de un solo fragmento no ofrecen las mismas ventajas que las configuraciones de varios fragmentos.

false

regionConfigs

[]objeto

Especificaciones de hardware para nodos definidos para una región determinada. Cada objeto regionConfigs describe la prioridad de la región en las elecciones y la cantidad y el tipo de nodos MongoDB que MongoDB Cloud implementa en la región. Cada objeto regionConfigs debe tener un objeto analyticsSpecs, un objeto electableSpecs o un objeto readOnlySpecs. Los clústeres de inquilinos solo requieren electableSpecs. Los clústeres dedicados pueden especificar cualquiera de estas especificaciones, pero deben tener al menos un objeto electableSpecs dentro de un replicationSpec. Todas las especificaciones de hardware deben usar el mismo instanceSize.

false

zoneName

string

Etiqueta legible por humanos que identifica la zona en un clúster global.

false

Name
Tipo
Descripción
Requerido

analyticsSpecs

Objeto

Especificaciones de hardware para los nodos de análisis implementados en la región.

false

autoScaling

Objeto

Opciones que determinan cómo este clúster maneja el escalamiento de recursos.

false

backingProviderName

enum

providerNameTENANTproviderSettingM2 M5ProveedorproviderNamede servicios en la nube donde se aprovisiona elhost para una implementación multiinquilino. Esta configuración solo funciona cuando " ": " " y ".``instanceSizeName``": o. De lo contrario, debe ser igual al valor " ". AWS GCPEnumeración:,, AZURE

false

electableSpecs

Objeto

Especificaciones de hardware para los nodos implementados en la región.

false

priority

entero

Esta región tiene prioridad en las elecciones primarias. Si su regionConfigs solo tiene readOnlySpecs, analyticsSpecs o ambos, configure este valor en 0. Si tiene varios objetos regionConfigs (su clúster es multirregión o multinube), deben tener prioridades en orden descendente. El priority más alto es 7.

false

providerName

enum

Enum: AWS, GCP, AZURE, TENANT, SERVERLESS

false

readOnlySpecs

Objeto

Especificaciones de hardware para nodos de sólo lectura desplegados en la región.

false

regionName

string

Ubicación física de su implementación MongoDB. La región que elija puede afectar la latencia de red de los clientes que acceden a sus bases de datos.

false

Especificaciones de hardware para los nodos de análisis implementados en la región.

Name
Tipo
Descripción
Requerido

diskIOPS

entero

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta opción solo si seleccionó AWS como proveedor de servicios en la nube. Formato: int64

false

ebsVolumeType

enum

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta configuración solo si seleccionó AWS como proveedor de servicios en la nube. STANDARDEnumeración:, PROVISIONED

false

instanceSize

string

Especificación de hardware para los tamaños de instancia en esta región. Cada tamaño de instancia tiene una capacidad de almacenamiento y memoria predeterminada. El tamaño de instancia que seleccione se aplica a todos los hosts que contienen datos en su tamaño de instancia.

false

nodeCount

entero

Número de nodos del tipo dado para que MongoDB nube los implemente en la región.

false

Opciones que determinan cómo este clúster maneja el escalamiento de recursos.

Name
Tipo
Descripción
Requerido

compute

Objeto

Colección de configuraciones que configuran cómo una implementación puede escalar su nivel de implementación y si la implementación puede reducir su escala.

false

diskGB

Objeto

Indicador que indica si el escalado automático de disco está habilitado. El valor predeterminado es "true".

false

Colección de configuraciones que configuran cómo una implementación puede escalar su nivel de implementación y si la implementación puede reducir su escala.

Name
Tipo
Descripción
Requerido

enabled

booleano

Marca que indica si el escalado automático de niveles de implementación está habilitado. El valor predeterminado es falso.

false

maxInstanceSize

string

Tamaño máximo de instancia al que su implementación puede escalarse automáticamente (por ejemplo, M40). Atlas requiere este parámetro si "autoScaling.compute.enabled" es verdadero.

false

minInstanceSize

string

Tamaño mínimo de instancia al que su implementación puede escalarse automáticamente (por ejemplo, M10). Atlas requiere este parámetro si "autoScaling.compute.``scaleDownEnabled``" es verdadero.

false

scaleDownEnabled

booleano

Indicador que indica si el nivel de implementación puede reducirse. Atlas requiere este parámetro si "autoScaling.compute.enabled" es verdadero.

false

Indicador que indica si el escalado automático de disco está habilitado. El valor predeterminado es "true".

Name
Tipo
Descripción
Requerido

enabled

booleano

Indicador que indica si este clúster habilita el escalado automático de discos. La memoria máxima permitida para el nivel de clúster seleccionado y el tamaño del registro de operaciones pueden limitar el escalado automático del almacenamiento.

false

Especificaciones de hardware para los nodos implementados en la región.

Name
Tipo
Descripción
Requerido

diskIOPS

entero

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta opción solo si seleccionó AWS como proveedor de servicios en la nube. Formato: int64

false

ebsVolumeType

enum

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta configuración solo si seleccionó AWS como proveedor de servicios en la nube. STANDARDEnumeración:, PROVISIONED

false

instanceSize

string

Especificación de hardware para los tamaños de instancia en esta región. Cada tamaño de instancia tiene una capacidad de almacenamiento y memoria predeterminada. El tamaño de instancia que seleccione se aplica a todos los hosts que contienen datos en su tamaño de instancia.

false

nodeCount

entero

Número de nodos del tipo dado para que MongoDB nube los implemente en la región.

false

Especificaciones de hardware para nodos de sólo lectura desplegados en la región.

Name
Tipo
Descripción
Requerido

diskIOPS

entero

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta opción solo si seleccionó AWS como proveedor de servicios en la nube. Formato: int64

false

ebsVolumeType

enum

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta configuración solo si seleccionó AWS como proveedor de servicios en la nube. STANDARDEnumeración:, PROVISIONED

false

instanceSize

string

Especificación de hardware para los tamaños de instancia en esta región. Cada tamaño de instancia tiene una capacidad de almacenamiento y memoria predeterminada. El tamaño de instancia que seleccione se aplica a todos los hosts que contienen datos en su tamaño de instancia.

false

nodeCount

entero

Número de nodos del tipo dado para que MongoDB nube los implemente en la región.

false

SearchIndex es el CRD para configurar parte del índice de búsqueda Atlas.

Name
Tipo
Descripción
Requerido

DBName

string

Etiqueta legible por humanos que identifica la base de datos que contiene la colección con uno o más índices de Atlas Search.

true

collectionName

string

Etiqueta legible por humanos que identifica la colección que contiene uno o más índices de Atlas Search.

true

name

string

Etiqueta legible que identifica este índice. Debe ser única para una implementación.

true

type

enum

Tipo del índice. Enum: búsqueda, vectorSearch

true

search

Objeto

Configuración del índice Atlas search.

false

vectorSearch

Objeto

Configuración del índice de búsqueda vectorial del Atlas.

false

Configuración del índice de búsqueda de Atlas.

Name
Tipo
Descripción
Requerido

mappings

Objeto

Especificaciones de índice para los campos de la colección.

true

searchConfigurationRef

Objeto

Una referencia al recurso personalizado AtlasSearchIndexConfig.

true

synonyms

[]objeto

Conjuntos de reglas que asignan palabras a su synonyms en este índice.

false

Especificaciones de índice para los campos de la colección.

Name
Tipo
Descripción
Requerido

dynamic

JSON

Indica si el índice utiliza dynamic asignaciones dynamic estáticas, dinámicas predeterminadas o dynamic configurables.dynamic Configúrelo en "true" para habilitar la asignación con el conjunto de tipos predeterminado, o bien, "define object" para especificar el nombre de los conjuntos de tipos configurados para la asignación. Si especifica asignaciones configurables, debe definir los conjuntos de tipos referenciados en el campo ``typeSets``. Configúrelo en "false" para usar solo asignaciones estáticas mediante mappings.fields. Consulte https://www.mongodb.com/es/docs/atlas/atlas-search/define-field-mappings/#configure-a-typeset para obtener más información.

false

fields

JSON

Una o más especificaciones de campo para el índice de búsqueda de Atlas. Obligatorio si mapping.dynamic se omite o se establece como falso.

false

Una referencia al recurso personalizado AtlasSearchIndexConfig.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Sinónimo representa el tipo "Sinónimo" de índice de búsqueda de Atlas.

Name
Tipo
Descripción
Requerido

analyzer

enum

Método específico predefinido elegido para aplicar a los sinónimos que se van a buscar. Enumeración: lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.cheche, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.rumano, lucene.ruso, lucene.smartcn, lucene.sorani, lucene.español, lucene.sueco, lucene.tailandés, lucene.turco, lucene.ucraniano

true

name

string

Etiqueta legible que identifica la definición del sinónimo. Cada name debe ser único dentro de la misma definición de índice.

true

source

Objeto

Conjunto de datos que almacena la correspondencia entre una o más palabras y uno o más sinónimos de esas palabras.

true

Conjunto de datos que almacena la correspondencia entre una o más palabras y uno o más sinónimos de esas palabras.

Name
Tipo
Descripción
Requerido

collection

string

Etiqueta legible por humanos que identifica el MongoDB collection que almacena las palabras y sus sinónimos aplicables.

true

Configuración del índice de búsqueda vectorial del Atlas.

Name
Tipo
Descripción
Requerido

fields

JSON

Matriz de JSON objetos. Ver ejemplos en https://dochub.mongodb.org/core/avs-vector-type

true

Name
Tipo
Descripción
Requerido

instanceSize

enum

Especificación de hardware para los tamaños de instancia del nodo de búsqueda. S20_HIGHCPU_NVMES30_HIGHCPU_NVMES40_HIGHCPU_NVMES50_HIGHCPU_NVMES60_HIGHCPU_NVMEEnumeración:,,,,,,,,,,,,,, S70_HIGHCPU_NVMES80_HIGHCPU_NVMES30_LOWCPU_NVMES40_LOWCPU_NVMES50_LOWCPU_NVMES60_LOWCPU_NVMES80_LOWCPU_NVMES90_LOWCPU_NVMES100_LOWCPU_NVMES110_LOWCPU_NVME

false

nodeCount

entero

Número de nodos de búsqueda en el clúster. Mínimo: 2 Máximo: 32

false

TagSpec contiene un par clave-valor para el etiquetado de recursos en esta implementación.

Name
Tipo
Descripción
Requerido

key

string

Constante que define el conjunto de la etiqueta.

true

value

string

Variable que pertenece al conjunto de la etiqueta.

true

externalProjectRef contiene el ID del proyecto Atlas principal. Se excluye mutuamente con el campo "projectRef".

Name
Tipo
Descripción
Requerido

id

string

ID es el proyecto Atlas ID.

true

Configuración para la API del clúster Flex. https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters

Name
Tipo
Descripción
Requerido

name

string

Etiqueta legible por humanos que identifica la instancia.

true

providerSettings

Objeto

Grupo de configuraciones del proveedor de nube que configuran el clúster flexible MongoDB aprovisionado.

true

tags

[]objeto

Lista que contiene pares clave-valor entre 1 y 255 caracteres de longitud para etiquetar y categorizar la instancia.

false

terminationProtectionEnabled

booleano

Marca que indica si la protección de terminación está habilitada en el clúster. Si se establece en "true", MongoDB Cloud no eliminará el clúster. Si se establece en "false", MongoDB Cloud eliminará el clúster. Predeterminado: "false"

false

Grupo de configuraciones del proveedor de nube que configuran el clúster flexible MongoDB aprovisionado.

Name
Tipo
Descripción
Requerido

backingProviderName

enum

Proveedor de servicios en la nube donde MongoDB Atlas aprovisiona el clúster flexible. Validaciones:

  • self ==:oldSelf El proveedor de respaldo no se puede modificar después de la creación del clúster AWSGCPEnum:,, AZURE

true

regionName

string

Etiqueta legible que identifica la ubicación geográfica de su MongoDB clúster flexible. La región que elija puede afectar la latencia de red de los clientes que acceden a sus bases de datos. Validaciones:

  • self == oldSelf: El nombre de la región no se puede modificar después de la creación del clúster

true

TagSpec contiene un par clave-valor para el etiquetado de recursos en esta implementación.

Name
Tipo
Descripción
Requerido

key

string

Constante que define el conjunto de la etiqueta.

true

value

string

Variable que pertenece al conjunto de la etiqueta.

true

ProcessArgs permite modificar las opciones de configuración avanzadas.

Name
Tipo
Descripción
Requerido

defaultReadConcern

string

Cadena que indica el nivel predeterminado de reconocimiento solicitado desde MongoDB para las operaciones de lectura establecidas para este clúster.

false

defaultWriteConcern

string

Cadena que indica el nivel predeterminado de reconocimiento solicitado desde MongoDB para las operaciones de escritura establecidas para este clúster.

false

failIndexKeyTooLong

booleano

Marca que indica si la operación falla y se devuelve un error al insertar o actualizar documentos donde todas las entradas indexadas superan 1024 bytes. Si se establece en falso, mongod escribe los documentos que superan este límite, pero no los indexa.

false

javascriptEnabled

booleano

Bandera que indica si el clúster permite la ejecución de operaciones que realizan ejecuciones del lado del servidor de JavaScript.

false

minimumEnabledTlsProtocol

string

Cadena que indica la versión mínima TLS que el clúster acepta para las conexiones entrantes. Los clústeres que usan TLS 1.0 u 1.1 deberían considerar configurar TLS 1.2 como la versión mínima del protocolo TLS.

false

noTableScan

booleano

Bandera que indica si el clúster deshabilita la ejecución de cualquier consulta que requiera un escaneo de colección para devolver resultados.

false

oplogMinRetentionHours

string

Ventana mínima de retención del registro de operaciones del clúster, expresada en horas. Un valor nulo indica que el clúster utiliza la ventana mínima predeterminada del registro de operaciones que MongoDB Cloud calcula.

false

oplogSizeMB

entero

Número que indica el límite de almacenamiento del registro de operaciones de un clúster, expresado en megabytes. Un valor nulo indica que el clúster utiliza el tamaño predeterminado del registro de operaciones calculado por Atlas. Formato: int64

false

sampleRefreshIntervalBIConnector

entero

Número que indica los documentos por base de datos que se muestrearán al recopilar información del esquema. Formato: int64

false

sampleSizeBIConnector

entero

Número que indica el intervalo en segundos en el que el proceso mongosqld remuestrea los datos para crear su esquema relacional. Formato: int64

false

projectRef es una referencia al recurso AtlasProject principal. Es mutuamente excluyente con el campo "externalProjectRef".

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Configuración de la API de implementación sin servidor. https://www.mongodb.com/es/docs/atlas/reference/api/serverless-instances/ OBSOLETO: Las instancias sin servidor están obsoletas.Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obtener más información.

Name
Tipo
Descripción
Requerido

name

string

Nombre de la implementación sin servidor tal como aparece en Atlas. Una vez que Atlas crea la implementación, no se puede cambiar su nombre. Solo puede contener ASCII letras, números y guiones.

true

providerSettings

Objeto

Configuración para los hosts aprovisionados en los que se ejecuta MongoDB. Las opciones disponibles son específicas del proveedor de servicios en la nube.

true

backupOptions

Objeto

Opciones de copia de seguridad sin servidor

false

privateEndpoints

[]objeto

Lista que contiene las configuraciones de los puntos de conexión privados para la instancia sinDEPRECATED servidor.: Los puntos de conexión privados sin servidor están obsoletos. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obtener más información.

false

tags

[]objeto

Pares clave-valor para etiquetado de recursos.

false

terminationProtectionEnabled

booleano

Marca que indica si la protección de terminación está habilitada en el clúster. Si se establece en "true", MongoDB Cloud no eliminará el clúster. Si se establece en "false", MongoDB Cloud eliminará el clúster. Predeterminado: "false"

false

Configuración de los hosts aprovisionados donde se ejecuta MongoDB. Las opciones disponibles son específicas del proveedor de servicios en la nube.

Name
Tipo
Descripción
Requerido

providerName

enum

Proveedor de servicios en la nube donde Atlas aprovisiona los hosts. AWSGCPAZURETENANTEnumeración:,,,, SERVERLESS

true

autoScaling

Objeto

Rango de tamaños de instancia a los que se puede escalar su implementación. DEPRECATED: El valor de este campo no tiene ningún efecto.

false

backingProviderName

enum

providerSettingProveedorTENANTproviderSettingM2 M5de servicios en la nube dondese aprovisiona el host para una implementación multiinquilino. Esta configuración solo funciona cuando ".``providerName``": " " y ".``instanceSizeName``": o. AWS GCPEnumeración:,, AZURE

false

diskIOPS

entero

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta opción solo si seleccionó AWS como proveedor de serviciosDEPRECATED en la nube.: El valor de este campo no tiene efecto. Formato: int64

false

diskTypeName

string

Tipo de disco si seleccionó Azure como su proveedor de servicios en la nube. DEPRECATED: El valor de este campo no tiene ningún efecto.

false

encryptEBSVolume

booleano

Bandera que indica si la función de cifrado de Amazon EBS cifra el volumen raíz del host tanto para los datos en reposo dentro del volumen como para los datos que se mueven entre el volumen y la implementación. DEPRECATED: el valor de este campo no tiene ningún efecto.

false

instanceSizeName

string

Atlas ofrece diferentes niveles de implementación, cada uno con una capacidad de almacenamiento predeterminada y un tamaño de RAM. La implementación que seleccione se utilizará para todos los hosts con datos en su nivel de implementación. DEPRECATED: El valor de este campo no tiene ningún efecto.

false

regionName

string

Ubicación física de su implementación MongoDB. La región que elija puede afectar la latencia de red de los clientes que acceden a sus bases de datos.

false

volumeType

enum

Configuración del disco para IOPS AWS el almacenamiento. Establezca esta opción solo si seleccionó AWS como proveedor de serviciosDEPRECATED en la nube.: El valor de este campo no tiene efecto. STANDARDEnumeración:, PROVISIONED

false

Rango de tamaños de instancia al que se puede escalar su implementación. OBSOLETO: El valor de este campo no tiene ningún efecto.

Name
Tipo
Descripción
Requerido

autoIndexingEnabled

booleano

Indicador que indica si el modo de piloto automático para Performance Advisor está habilitado. El valor predeterminado es falso. DEPRECATED: Este indicador ya no se admite.

false

compute

Objeto

Colección de configuraciones que configuran cómo una implementación puede escalar su nivel de implementación y si la implementación puede reducir su escala.

false

diskGBEnabled

booleano

Indicador que indica si el escalado automático de disco está habilitado. El valor predeterminado es "true".

false

Colección de configuraciones que configuran cómo una implementación puede escalar su nivel de implementación y si la implementación puede reducir su escala.

Name
Tipo
Descripción
Requerido

enabled

booleano

Marca que indica si el escalado automático de niveles de implementación está habilitado. El valor predeterminado es falso.

false

maxInstanceSize

string

Tamaño máximo de instancia al que su implementación puede escalarse automáticamente (por ejemplo, M40). Atlas requiere este parámetro si "autoScaling.compute.enabled" es verdadero.

false

minInstanceSize

string

Tamaño mínimo de instancia al que su implementación puede escalarse automáticamente (por ejemplo, M10). Atlas requiere este parámetro si "autoScaling.compute.``scaleDownEnabled``" es verdadero.

false

scaleDownEnabled

booleano

Indicador que indica si el nivel de implementación puede reducirse. Atlas requiere este parámetro si "autoScaling.compute.enabled" es verdadero.

false

Opciones de copia de seguridad sin servidor

Name
Tipo
Descripción
Requerido

serverlessContinuousBackupEnabled

booleano

ServerlessContinuousBackupEnabled Indica si el clúster utiliza copias de seguridad continuas en laDEPRECATED nube.: Las instancias sin servidor están obsoletas y ya no admiten copias de seguridad continuas. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obtener más información. Valor predeterminado: verdadero.

false

ServerlessPrivateEndpoint configura puntos finales privados para las instancias sin servidor. OBSOLETO: Los puntos finales privados sin servidor están obsoletos. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obtener más información.

Name
Tipo
Descripción
Requerido

cloudProviderEndpointID

string

CloudProviderEndpointID es el identificador del punto final del proveedor de la nube.

false

name

string

El nombre es el name del servicio sin servidor PrivateLink. Debe ser único.

false

privateEndpointIpAddress

string

PrivateEndpointIPAddress es la dirección IPv4 del punto de conexión privado en su red virtual de Azure que alguien agregó a este servicio de punto de conexión privado.

false

TagSpec contiene un par clave-valor para el etiquetado de recursos en esta implementación.

Name
Tipo
Descripción
Requerido

key

string

Constante que define el conjunto de la etiqueta.

true

value

string

Variable que pertenece al conjunto de la etiqueta.

true

AtlasDeploymentStatus define el estado observado de AtlasDeployment.

Name
Tipo
Descripción
Requerido

conditions

[]objeto

Condiciones es la lista de estados que muestra el estado actual del recurso personalizado de Atlas

true

connectionStrings

Objeto

ConnectionStrings es un conjunto de cadenas de conexión que sus aplicaciones utilizan para conectarse a este clúster.

false

customZoneMapping

Objeto

Lista que contiene pares clave-valor para asignar zonas a regiones geográficas. Estos pares asignan un código de ubicación ISO 3166-1a2, con un código de subdivisión ISO 3166-2 cuando sea posible, a una cadena hexadecimal 24única que identifica la zona personalizada.

false

managedNamespaces

[]objeto

Lista que contiene un espacio de nombres para un clúster global. MongoDB Atlas administra este clúster.

false

mongoDBVersion

string

MongoDBVersion es la versión de MongoDB que ejecuta el clúster, en formato .

false

mongoURIUpdated

string

MongoURIUpdated Es una marca de tiempo en formato ISO 8601 de fecha y hora en UTC de la última actualización de la cadena de conexión. La cadena de conexión cambia si se actualiza cualquier otro valor.

false

observedGeneration

entero

ObservedGeneration Indica la generación de la especificación del recurso que el operador Atlas conoce. El operador Atlas actualiza este campo con el valor 'metadata.generation' en cuanto inicia la conciliación del recurso. Formato: int64

false

replicaSets

[]objeto

Detalles que explican cómo MongoDB Cloud replica datos en la base de datos MongoDB especificada. Esta matriz tiene un objeto por fragmento que representa las configuraciones de los nodos en cada fragmento. Para los conjuntos de réplicas, solo hay un objeto que representa las configuraciones de los nodos.

false

searchIndexes

[]objeto

SearchIndexes Contiene una lista de estados de índices de búsqueda configurados para un proyecto.

false

serverlessPrivateEndpoints

[]objeto

ServerlessPrivateEndpoints Contiene una lista de puntos finales privados configurados para la implementación sin servidor.

false

stateName

string

StateName Es el estado actual del clúster. Los estados posibles son: IDLE, CREATING, UPDATING, DELETING, DELETED, REPAIRING

false

La condición describe el estado de un recurso personalizado de Atlas en un momento determinado.

Name
Tipo
Descripción
Requerido

status

string

Estado de la condición; uno de Verdadero, Falso, Desconocido.

true

type

string

Tipo de condición de recurso personalizado de Atlas.

true

lastTransitionTime

string

Última vez que la condición cambió de un estado a otro. Representado en ISO 8601 formato. Formato: fecha y hora.

false

message

string

A message proporcionando detalles sobre la transición.

false

reason

string

El reason para la última transición de la condición.

false

ConnectionStrings es un conjunto de cadenas de conexión que sus aplicaciones utilizan para conectarse a este clúster.

Name
Tipo
Descripción
Requerido

private

string

Cadenas de conexión mongodb:// con reconocimiento del endpoint de emparejamiento de red para cada endpoint de interfaz VPC que configuraste para conectarte a este clúster. Atlas devuelve este parámetro solo si creaste una conexión peering de red a este clúster.

false

privateEndpoint

[]objeto

Cadenas de conexión de endpoints privados. Cada objeto describe las cadenas de conexión que puede usar para conectarse a este clúster a través de un endpoint privado. Atlas devuelve este parámetro solo si implementó un endpoint privado en todas las regiones donde se implementaron los nodos de este clúster.

false

privateSrv

string

Cadenas de conexión mongodb+srv:// compatibles con puntos finales de interconexión de red para cada punto final de la interfaz VPC que haya configurado para conectarse a este clúster. Atlas solo devuelve este parámetro si creó una conexión de interconexión de red con este clúster. Use este formato URI si su controlador lo admite. De lo contrario, use connectionStrings.private.

false

standard

string

Cadena de conexión pública mongodb:// para este clúster.

false

standardSrv

string

Cadena de conexión pública mongodb+srv:// para este clúster.

false

Cadenas de conexión de punto final privado. Cada objeto describe las cadenas de conexión que puede usar para conectarse a este clúster a través de un punto final privado. Atlas devuelve este parámetro solo si implementó un punto final privado en todas las regiones donde se implementaron los nodos de este clúster.

Name
Tipo
Descripción
Requerido

connectionString

string

Cadena de conexión mongodb:// compatible con puntos finales privados para este punto final privado.

false

endpoints

[]objeto

Punto final privado a través del cual se conecta a Atlas cuando usa connectionStrings.``privateEndpoint``[n].``connectionString`` o connectionStrings.``privateEndpoint``[n].``srvConnectionString``.

false

srvConnectionString

string

Cadena de conexión mongodb+srv:// compatible con puntos finales privados para este punto final privado.

false

srvShardOptimizedConnectionString

string

Cadena de conexión que reconoce puntos finales privados y está optimizada para clústeres fragmentados que utilizan el protocolo mongodb+srv:// para conectarse a la nube MongoDB a través de un punto final privado.

false

type

string

Tipo de proceso MongoDB al que se conecta con las cadenas de conexión que Atlas devuelve: • MONGOD para conjuntos de réplicas, o • MONGOS para clústeres fragmentados

false

Punto final a través del cual se conecta a Atlas

Name
Tipo
Descripción
Requerido

endpointId

string

Identificador único del punto final privado.

false

ip

string

Dirección privada IP de la interfaz de red de punto final privado que creó en su red virtual de Azure.

false

providerName

string

Proveedor de nube en el que implementaste el nodo privado. Atlas devuelve AWS o AZURE.

false

region

string

Región en la que implementó el punto final privado.

false

Lista que contiene pares clave-valor para asignar zonas a regiones geográficas. Estos pares asignan un código de ubicación ISO 3166-1a2, con un código de subdivisión ISO 3166-2 cuando sea posible, a una cadena hexadecimal 24única que identifica la zona personalizada.

Name
Tipo
Descripción
Requerido

customZoneMapping

mapa[cadena]cadena

Lista que contiene pares clave-valor para asignar zonas a regiones geográficas. Estos pares asignan un código de ubicación ISO 3166-1a2, con un código de subdivisión ISO 3166-2 cuando sea posible, a una cadena hexadecimal 24única que identifica la zona personalizada.

false

zoneMappingErrMessage

string

Mensaje de error por mapeo de zona personalizada fallido.

false

zoneMappingState

string

Estado del mapeo de zonas personalizadas.

false

Name
Tipo
Descripción
Requerido

collection

string

Etiqueta legible por humanos del collection que se administrará para este clúster global.

true

db

string

Etiqueta legible por humanos de la base de datos que se administrará para este clúster global.

true

customShardKey

string

Parámetro de base de datos utilizado para dividir la colección en fragmentos. Los clústeres globales requieren una clave de fragmento compuesta. Esta clave de fragmento compuesta combina el parámetro de ubicación y la clave personalizada seleccionada por el usuario.

false

errMessage

string

Mensaje de error para un espacio de nombres administrado fallido.

false

isCustomShardKeyHashed

booleano

Marca que indica si se ha generado un hash de la clave de fragmento personalizada para la colección especificada. Si se establece este valor en falso, MongoDB Atlas utiliza fragmentación por rango.

false

isShardKeyUnique

booleano

Indicador que indica si se ha generado un hash de la clave de fragmento personalizada. Si este parámetro devuelve "false", el clúster utiliza fragmentación por rango.

false

numInitialChunks

entero

Número mínimo de fragmentos a crear inicialmente al fragmentar una colección vacía con una clave de fragmento con hash.

false

presplitHashedZones

booleano

Bandera que indica si MongoDB Cloud debe crear y distribuir fragmentos iniciales para una colección vacía o inexistente. MongoDB Atlas distribuye datos según las zonas y los rangos de zonas definidos para la colección.

false

status

string

Estado del namespace gestionado.

false

Name
Tipo
Descripción
Requerido

id

string

Cadena de dígitos hexadecimales 24única que identifica el objeto de replicación de un fragmento en un clúster.

true

zoneName

string

Etiqueta legible por humanos que describe la zona a la que pertenece este fragmento en un clúster global.

false

Name
Tipo
Descripción
Requerido

ID

string

Cadena de dígitos hexadecimales 24única que identifica este índice de búsqueda de Atlas.

true

message

string

Detalles sobre el estado del índice de búsqueda.

true

name

string

Etiqueta legible por humanos que identifica este índice.

true

status

string

Estado del índice de búsqueda.

true

Name
Tipo
Descripción
Requerido

_id

string

ID es el identificador del servicio Serverless PrivateLink.

false

cloudProviderEndpointId

string

CloudProviderEndpointID es el identificador del punto final del proveedor de la nube.

false

endpointServiceName

string

EndpointServiceName Es el nombre del servicio de punto final PrivateLink en AWS. Devuelve nulo mientras se crea el servicio de punto final.

false

errorMessage

string

ErrorMessage es el mensaje de error si el servicio Serverless PrivateLink no pudo crearse o conectarse.

false

name

string

El nombre es el name del servicio sin servidor PrivateLink. Debe ser único.

false

privateEndpointIpAddress

string

PrivateEndpointIPAddress es la dirección IPv4 del punto de conexión privado en su red virtual de Azure que alguien agregó a este servicio de punto de conexión privado.

false

privateLinkServiceResourceId

string

PrivateLinkServiceResourceID es la ruta relativa a la raíz que identifica el servicio de enlace privado de Azure que administra MongoDB Cloud. MongoDB Cloud devuelve nulo mientras crea el servicio de punto de conexión.

false

providerName

string

ProviderName Es una etiqueta legible que identifica al proveedor de la nube. Los valores incluyen AWS o AZURE.

false

status

string

Estado de la conexión AWS Serverless PrivateLink.

false

Volver

Proyecto Atlas