ClusterCluster is the Schema for the Clusters API.
TypeMR
Providerprovider-mongodbatlas
Groupmongodbatlas.m.crossplane.io
Scopenamespaced
Versionv1alpha2

1apiVersion: mongodbatlas.m.crossplane.io/v1alpha2

2kind: Cluster

kind
string
metadata
object
spec
object

ClusterSpec defines the desired state of Cluster

forProvider
required
object

(No description available)

array

(No description available)

array

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

labels
array

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

key
string
value
string
name
string
numShards
number
paused
boolean
array

Pins the Feature Compatibility Version (FCV) to the current MongoDB version with a provided expiration date. To unpin the FCV the pinned_fcv attribute must be removed. This operation can take several minutes as the request processes through the MongoDB data plane. Once FCV is unpinned it will not be possible to downgrade the mongo_db_major_version. It is advised that updates to pinned_fcv are done isolated from other cluster changes. If a plan contains multiple changes, the FCV change will be applied first. If FCV is unpinned past the expiration date the pinned_fcv attribute must be removed. The following knowledge hub article and FCV documentation can be referenced for more details. See below.

pitEnabled
boolean
projectId
string
object

Reference to a Project in mongodbatlas to populate projectId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Project in mongodbatlas to populate projectId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

Configuration for cluster regions. See Replication Spec below for more details.

id
string
numShards
number
array

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

zoneName
string
tags
array

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

key
string
value
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

(No description available)

array

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

labels
array

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

key
string
value
string
name
string
numShards
number
paused
boolean
array

Pins the Feature Compatibility Version (FCV) to the current MongoDB version with a provided expiration date. To unpin the FCV the pinned_fcv attribute must be removed. This operation can take several minutes as the request processes through the MongoDB data plane. Once FCV is unpinned it will not be possible to downgrade the mongo_db_major_version. It is advised that updates to pinned_fcv are done isolated from other cluster changes. If a plan contains multiple changes, the FCV change will be applied first. If FCV is unpinned past the expiration date the pinned_fcv attribute must be removed. The following knowledge hub article and FCV documentation can be referenced for more details. See below.

pitEnabled
boolean
projectId
string
object

Reference to a Project in mongodbatlas to populate projectId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Project in mongodbatlas to populate projectId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

Configuration for cluster regions. See Replication Spec below for more details.

id
string
numShards
number
array

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

zoneName
string
tags
array

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

key
string
value
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

kind
required
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

name
required
string
status
object

ClusterStatus defines the observed state of Cluster.

object

(No description available)

array

(No description available)

array

Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See BI Connector below for more details.

clusterId
string
array

Set of connection strings that your applications use to connect to this cluster. More information in Connection-strings. Use the parameters in this object to connect your applications to this cluster. To learn more about the formats of connection strings, see Connection String Options. NOTE: Atlas returns the contents of this object after the cluster is operational, not while it builds the cluster.

private
string
array

Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.

array

Private endpoint through which you connect to Atlas when you use connection_strings.#.private_endpoint.#.connection_string or connection_strings.#.private_endpoint.#.srv_connection_string

type
string
standard
string
id
string
labels
array

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below. DEPRECATED Use tags instead.

key
string
value
string
mongoUri
string
name
string
numShards
number
paused
boolean
array

Pins the Feature Compatibility Version (FCV) to the current MongoDB version with a provided expiration date. To unpin the FCV the pinned_fcv attribute must be removed. This operation can take several minutes as the request processes through the MongoDB data plane. Once FCV is unpinned it will not be possible to downgrade the mongo_db_major_version. It is advised that updates to pinned_fcv are done isolated from other cluster changes. If a plan contains multiple changes, the FCV change will be applied first. If FCV is unpinned past the expiration date the pinned_fcv attribute must be removed. The following knowledge hub article and FCV documentation can be referenced for more details. See below.

pitEnabled
boolean
projectId
string
array

Configuration for cluster regions. See Replication Spec below for more details.

id
string
numShards
number
array

Physical location of the region. Each regionsConfig document describes the region’s priority in elections and the number and type of MongoDB nodes Atlas deploys to the region. You must order each regionsConfigs document by regionsConfig.priority, descending. See Region Config below for more details.

zoneName
string
array

current snapshot schedule and retention settings for the cluster.

clusterId
string
array

A list of policy definitions for the cluster.

id
string
array

A list of specifications for a policy.

stateName
string
tags
array

Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.

key
string
value
string
array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string