AtlasDeployment 自定义资源

backupRef

对象

参考 AtlasDeployment 的备份安排。

false

connectionSecret

对象

包含Atlas API 私钥和公钥的密钥名称。

false

deploymentSpec

对象

高级 (v1.5)部署API https://www.mongodb.com/zh-cn/docs/atlas/reference/api/clusters/

false

externalProjectRef

对象

externalProjectRef 包含父Atlas项目ID。与“projectRef”字段互斥。

false

flexSpec

对象

Flex集群API 的配置。https://www.mongodb.com/zh-cn/docs/atlas/reference/api-resources-spec/v2/#标签/Flex-Clusters

false

processArgs

对象

ProcessArgs 允许修改高级配置选项。

false

projectRef

对象

projectRef 是对父 AtlasProject资源的引用。与“externalProjectRef”字段互斥。

false

serverlessSpec

对象

无服务器部署API 的配置。https://www.mongodb.com/zh-cn/docs/atlas/reference/api/serverless-instances/DEPRECATED：无服务器实例已弃用。请参阅 https://dochub.mongodb.org/core/atlas-Flex-migration 了解详细信息。

false

upgradeToDedicated

布尔

upgradeToDedicated，当设立为 true 时，会触发从 Flex 集群到专用集群的迁移。用户 MUST 提供新的专用集群配置。如果集群已经是专用的，则忽略此标志。

false

name

字符串

Atlas中显示的高级部署的名称。Atlas创建部署后，您无法更改其名称。只能包含 ASCII 字母、数字和连字符。验证:

• self == oldSelf：名称在创建部署后无法修改

true

backupEnabled

布尔

指示部署是否使用云备份进行备份的标志。仅适用于 M10``+ 部署。

false

biConnector

对象

在此部署上为Atlas配置 BI Connector。MongoDB Connector for Business Intelligence for Atlas （BI Connector）仅适用于 M10 和更大的部署。

false

clusterType

枚举

要创建的部署的类型。如果部署了replicationSpecs 或部署了全局部署，则该参数为必填项。枚举：REPLICASET、SHARDED、GEOSHARDED

false

configServerManagementMode

枚举

用于创建或更新分片集群的配置服务器管理模式。枚举：ATLAS_MANAGED、FIXED_TO_DEDICATED

false

customZoneMapping

[]对象

包含将区域映射到地理区域的Atlas全球集群参数的列表。

false

diskSizeGB

整型

托管根卷的容量（以 GB 为单位）。增加此数字可增加容量，最大可能值为 4096（即 4 TB）。此值必须是正整数。如果配置了 replicationSpecs，则该参数为必填项。最小值：0 最大值：4096

false

encryptionAtRestProvider

枚举

提供静态加密的云服务提供商。枚举：AWS、GCP、AZURE、NONE

false

labels

[]对象

用于标签和分类部署的键值对集合。每个键和值的最大长度为 255 个字符。DEPRECATED：集群 labels 已弃用，将在未来发布中删除。我们强烈建议您改用资源标签。

false

managedNamespaces

[]对象

列表，其中包含在要创建的指定Atlas全球集群中创建托管命名空间的信息。

false

mongoDBMajorVersion

字符串

MongoDB 集群的主要版本。设置为二进制主要版本。

false

mongoDBVersion

字符串

集群运行的 MongoDB 版本。

false

paused

布尔

指示部署是否应暂停的标志。

false

pitEnabled

布尔

指示部署使用连续云备份的标志。

false

replicationSpecs

[]对象

部署区域的配置。

false

rootCertType

字符串

MongoDB Atlas 集群使用的根证书颁发机构。

false

searchIndexes

[]对象

SearchIndex 个对象的数组，其中包含描述搜索索引的字段。

false

searchNodes

[]对象

集群搜索节点的设置。目前，最多可以定义一个搜索节点配置。

false

tags

[]对象

用于资源标签的键值对。

false

terminationProtectionEnabled

布尔

指示是否在集群上启用终止保护的标志。如果设立为 true，MongoDB 云将不会删除集群。如果设立为 false，MongoDB 云将删除集群。默认：false

false

versionReleaseSystem

字符串

集群维护 MongoDB 版本的方法。如果值为 CONTINUOUS，则不得指定 mongoDBMajorVersion。

false

collection

字符串

用于管理此 Atlas全球集群 的 collection 的人类可读标签。

true

db

字符串

用于管理此全局集群的数据库的人工可读标签。

true

customShardKey

字符串

用于将集合划分为分片的数据库参数。全局集群需要复合分片键。此复合分片键将位置参数和用户选择的自定义键组合在一起。

false

isCustomShardKeyHashed

布尔

指示是否有人对指定集合的自定义分片键进行了哈希的标志。如果将此值设立为 false，MongoDB 云将使用范围分片。

false

isShardKeyUnique

布尔

指示是否有人对自定义分片键哈希的标志。如果该参数返回 false，则该集群使用范围 分片。

false

numInitialChunks

整型

使用哈希分片键对空集合进行分片时，最初创建的最小数据块数。最大值为 8192。

false

presplitHashedZones

布尔

该标志指示 MongoDB 云是否应为空或不存在的集合创建和分发初始数据块。MongoDB 云根据为集合定义的区域和区域范围来分发数据。

false

analyticsSpecs

对象

该区域中部署的分析节点的硬件规格。

false

autoScaling

对象

确定此集群如何处理资源扩展的选项。

false

backingProviderName

枚举

为多租户部署预配托管的云服务提供商。此设置仅在以下情况下有效： "providerName" : "TENANT" and "providerSetting.``instanceSizeName``"：M2 或 M5。否则，它应等于“providerName”值。枚举：AWS、GCP、AZURE

false

electableSpecs

对象

该地区中部署的节点的硬件规格。

false

priority

整型

进行主节点 (primary node in the replica set)选举时，该区域优先。如果您的 regionConfigs 仅具有 readOnlySpecs、analyticsSpecs 或两者，请将此值设立为 0。如果您有多个 regionConfigs 对象（您的集群是多区域或多云），则它们的优先级必须按降序排列。最高的 priority 为 7

false

providerName

枚举

Enum: AWS, GCP, AZURE, TENANT, SERVERLESS

false

readOnlySpecs

对象

该区域中部署的只读节点的硬件规格。

false

regionName

字符串

MongoDB部署的物理位置。您选择的区域可能会影响客户端访问数据库的网络延迟。

false

DBName

字符串

人类可读标签，用于标识包含具有一个或多个 Atlas Search 索引的集合的数据库。

true

collectionName

字符串

可读标签，用于标识包含一个或多个 Atlas Search 索引的集合。

true

name

字符串

标识此索引的人类可读标签。 对于部署必须是唯一的。

true

type

枚举

索引的类型。枚举： 搜索, vectorSearch

true

search

对象

Atlas search索引配置。

false

vectorSearch

对象

Atlas 向量搜索索引配置。

false

defaultReadConcern

字符串

字符串，表示为此集群设立的读操作从 MongoDB 请求的默认确认级别。

false

defaultWriteConcern

字符串

String，表示为此集群设立的写入操作从 MongoDB 请求的默认确认级别。

false

failIndexKeyTooLong

布尔

标志，用于指示在插入或更新所有索引项都超过 1024 字节的文档时是否使操作失败并返回错误。如果将其设立为 false，mongod会写入超过此限制的文档，但不会对其索引。

false

javascriptEnabled

布尔

指示集群是否允许执行在服务器端进行的 JavaScript 操作的标志。

false

minimumEnabledTlsProtocol

字符串

字符串，表示集群接受的传入连接的最低 TLS 版本。使用 TLS 1.0 或 1.1 的集群应考虑将 TLS 1.2 设置为最低 TLS协议版本。

false

noTableScan

布尔

该标志指示集群是否禁用执行需要集合扫描才能返回结果的查询。

false

oplogMinRetentionHours

字符串

集群oplog的最小保留窗口以小时为单位。null 值表示集群使用 MongoDB 云 计算的默认最小oplog window。

false

oplogSizeMB

整型

指示集群oplog存储限制的数字，以兆字节为单位。null 值表示集群使用Atlas计算的默认oplog大小。格式：int64

false

sampleRefreshIntervalBIConnector

整型

数字，表示收集模式信息时要示例的每个数据库的文档数量。格式：int64

false

sampleSizeBIConnector

整型

数字，表示 mongosqld 进程重新示例数据以创建其关系模式的时间间隔（以秒为单位）。格式：int64

false

name

字符串

Atlas中显示的无服务器部署的名称。Atlas创建部署后，您无法更改其名称。只能包含 ASCII 字母、数字和连字符。

true

providerSettings

对象

运行 MongoDB 的已预配托管的配置。可用选项特定于云服务提供商。

true

backupOptions

对象

serverlessBackupOptions

false

privateEndpoints

[]对象

包含无服务器实例的私有端点配置的列表。DEPRECATED：无服务器私有端点已弃用。请参阅 https://dochub.mongodb.org/core/atlas-Flex-migration 了解详细信息。

false

tags

[]对象

用于资源标签的键值对。

false

terminationProtectionEnabled

布尔

指示是否在集群上启用终止保护的标志。如果设立为 true，MongoDB 云将不会删除集群。如果设立为 false，MongoDB 云将删除集群。默认：false

false

providerName

枚举

Atlas在其上预配托管的云服务提供商。枚举：AWS、GCP、AZURE、TENANT、SERVERLESS

true

autoScaling

对象

部署可扩展的实例大小范围。DEPRECATED：该字段的值没有任何作用。

false

backingProviderName

枚举

为多租户部署预配托管的云服务提供商。此设置仅在 "providerSetting.``providerName``"："TENANT" 和 "providerSetting.``instanceSizeName``"：M2 或 M5。枚举：AWS、GCP、AZURE

false

diskIOPS

整型

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。DEPRECATED：该字段的值没有任何作用。格式：int64

false

diskTypeName

字符串

磁盘类型（如果选择Azure作为云服务提供商）。DEPRECATED：该字段的值没有任何作用。

false

encryptEBSVolume

布尔

指示Amazon EBS加密功能是否会针对卷内的静态数据以及在卷与部署之间移动的数据对托管的根卷进行加密的标志。DEPRECATED：该字段的值没有任何作用。

false

instanceSizeName

字符串

Atlas提供不同的部署层级，每个部署层级都有默认的存储容量和 RAM 大小。您选择的部署将用于部署层级中的所有数据承载托管。DEPRECATED：该字段的值没有任何作用。

false

regionName

字符串

MongoDB部署的物理位置。您选择的区域可能会影响客户端访问数据库的网络延迟。

false

volumeType

枚举

AWS存储的磁盘 IOPS 设置。仅在选择 AWS 作为云服务提供商时才设置。DEPRECATED：该字段的值没有任何作用。枚举：STANDARD、PROVISIONED

false

conditions

[]对象

条件是显示Atlas自定义资源当前省/市/自治区的列表

true

connectionStrings

对象

ConnectionStrings 是应用程序用于连接到此集群的**一组**连接字符串。

false

customZoneMapping

对象

列表，其中包含用于将区域映射到区域的键值对。这些对将 ISO 3166-1a2位置代码（尽可能包含 ISO 3166-2 细分代码）映射到唯一的 24-十六进制字符串，该字符串标识自定义区域。

false

managedNamespaces

[]对象

包含Atlas全球集群命名空间的列表。MongoDB Atlas托管此集群。

false

mongoDBVersion

字符串

MongoDBVersion 是集群运行的 MongoDB 版本，格式为 。格式。

false

mongoURIUpdated

字符串

MongoURIUpdated 是上次更新连接字符串时采用 ISO 8601 日期和时间格式（以 UTC 表示）的时间戳。如果更新任何其他值，连接字符串也会更改。

false

observedGeneration

整型

ObservedGeneration 表示 Atlas 操作符 感知的资源规范的生成。Atlas Operator 将此字段更新为“元数据.Generation ”的值一旦开始资源协调。格式：int64

false

replicaSets

[]对象

说明 MongoDB 云如何在指定的 MongoDB数据库上复制数据的详细信息。该数组中每个分片有一个对象，表示每个分片中的节点配置。对于副本集，只有一个表示节点配置的对象。

false

searchIndexes

[]对象

SearchIndexes 包含为项目配置的搜索索引状态列表。

false

serverlessPrivateEndpoints

[]对象

ServerlessPrivateEndpoints 包含为无服务器部署配置的私有端点列表。

false

stateName

字符串

StateName 是集群的当前省/市/自治区。可能的省有：IDLE、CREATING、UPDATING、DELETING、DELETED、REPAIRING

false

status

字符串

条件的状态； True、False、未知之一。

true

type

字符串

Atlas自定义资源条件的类型。

true

lastTransitionTime

字符串

上次条件从一种状态转换为另一种状态的时间。以 ISO 8601 格式表示。格式：日期-时间

false

message

字符串

提供有关转换的详细信息的 message。

false

reason

字符串

条件的最后一次转换的 reason。

false

private

字符串

Network-peering-endpoint-aware mongodb:// 配置为连接到此集群的每个接口 VPC 端点的连接字符串。仅当您创建了与此集群的网络对等连接时，Atlas才会返回此参数。

false

privateEndpoint

[]对象

私有端点连接字符串。每个对象都描述了可用于通过私有端点连接到此集群的连接字符串。仅当您将私有端点部署到部署此集群节点的所有区域时，Atlas才会返回此参数。

false

privateSrv

字符串

Network-peering-endpoint-aware mongodb+srv:// 配置为连接到此集群的每个接口 VPC 端点的连接字符串。仅当您创建了与此集群的网络对等连接时，Atlas才会返回此参数。如果您的驱动程序支持，请使用此 URI 格式。如果没有，则使用 connectionStrings.private。

false

standard

字符串

Public mongodb:// 此集群的连接字符串。

false

standardSrv

字符串

公共 mongodb+srv:// 此集群的连接字符串。

false

connectionString

字符串

Private-endpoint-aware mongodb:// 此私有端点连接字符串。

false

endpoints

[]对象

私有端点，当您使用 connectionStrings.``privateEndpoint``[n].``connectionString`` 或 connectionStrings.``privateEndpoint``[n].``srvConnectionString`` 时，通过该端点连接到Atlas 。

false

srvConnectionString

字符串

Private-endpoint-aware mongodb+srv:// 此私有端点的连接字符串。

false

srvShardOptimizedConnectionString

字符串

针对使用 mongodb+srv://协议通过私有端点连接到 MongoDB 云的分片集群进行了优化的私有端点感知连接字符串。

false

type

字符串

使用Atlas返回的连接字符串连接到的 MongoDB 进程的类型：• MONGOD 表示副本集，或 • MONGOS 分片集群

false

collection

字符串

用于管理此 Atlas全球集群 的 collection 的人类可读标签。

true

db

字符串

用于管理此全局集群的数据库的人工可读标签。

true

customShardKey

字符串

用于将集合划分为分片的数据库参数。全局集群需要复合分片键。此复合分片键将位置参数和用户选择的自定义键组合在一起。

false

errMessage

字符串

托管命名空间失败的错误消息。

false

isCustomShardKeyHashed

布尔

指示是否有人对指定集合的自定义分片键进行了哈希的标志。如果将此值设立为 false，MongoDB Atlas将使用范围分片。

false

isShardKeyUnique

布尔

指示是否有人对自定义分片键哈希的标志。如果该参数返回 false，则该集群使用范围 分片。

false

numInitialChunks

整型

指定使用哈希分片键对空集合进行分片时最初创建的最小数据块数。

false

presplitHashedZones

布尔

该标志指示 MongoDB 云是否应为空或不存在的集合创建和分发初始数据块。MongoDB Atlas根据集合的定义区域和区域范围来分发数据。

false

status

字符串

托管命名空间的状态。

false

_id

字符串

ID 是无服务器 PrivateLink 服务的标识符。

false

cloudProviderEndpointId

字符串

CloudProviderEndpointID 是云提供商终结点的标识符。

false

endpointServiceName

字符串

EndpointServiceName 是 AWS 中 PrivateLink 终结点服务的名称。创建终结点服务时返回 null。

false

errorMessage

字符串

ErrorMessage 是无服务器 PrivateLink 服务创建或连接失败时的错误消息。

false

name

字符串

名称是无服务器 PrivateLink 服务的 name。应该是唯一的。

false

privateEndpointIpAddress

字符串

PrivateEndpointIPAddress 是有人添加到此私有端点服务的 Azure VNet 中私有端点的 IPv4地址。

false

privateLinkServiceResourceId

字符串

PrivateLinkServiceResourceID 是根目录相对路径，用于标识 MongoDB 云 托管的 Azure Private Link 服务。MongoDB 云在创建终结点服务时返回 null。

false

providerName

字符串

ProviderName 是人类可读标签，用于标识云提供商。值包括 AWS 或 AZURE。

false

status

字符串

AWS无服务器 PrivateLink 连接的状态。

false