AdvancedClusterAdvancedCluster is the Schema for the AdvancedClusters API.
TypeMR
Providerprovider-mongodbatlas
Groupmongodbatlas.m.crossplane.io
Scopenamespaced
Versionv1alpha3

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

2kind: AdvancedCluster

kind
string
metadata
object
spec
object

AdvancedClusterSpec defines the desired state of AdvancedCluster

forProvider
required
object

(No description available)

object

(No description available)

array

The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_mode is set to CUSTOM. The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_mode is set to CUSTOM.

array

The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when tls_cipher_config_mode is set to CUSTOM. The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when tls_cipher_config_mode is set to CUSTOM.

object

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

labels
object
name
string
paused
boolean
pinnedFcv
object

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

List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. The replication_specs configuration for all shards within the same zone must be the same, with the exception of instance_size and disk_iops that can scale independently. Note that independent disk_iops values are only supported for AWS provisioned IOPS, or Azure regions that support Extended IOPS. See below.

array

Configuration for the hardware specifications for nodes set for a given region. Each region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below.

object

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling attribute must be the same for all region_configs of a cluster. See below.

object

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below.

object

Configuration for the collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling attribute must be the same for all region_configs of a cluster. See below.

object

Hardware specifications for electable nodes in the region. All electable_specs in the region_configs of a replication_specs must have the same instance_size. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below.

priority
number
object

Hardware specifications for read-only nodes in the region. All read_only_specs in the region_configs of a replication_specs must have the same instance_size as electable_specs. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below.

zoneName
string
tags
object
timeouts
object

(Attributes) (see below for nested schema)

create
string
delete
string
update
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.

object

(No description available)

array

The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_mode is set to CUSTOM. The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_mode is set to CUSTOM.

array

The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when tls_cipher_config_mode is set to CUSTOM. The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when tls_cipher_config_mode is set to CUSTOM.

object

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

labels
object
name
string
paused
boolean
pinnedFcv
object

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

List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. The replication_specs configuration for all shards within the same zone must be the same, with the exception of instance_size and disk_iops that can scale independently. Note that independent disk_iops values are only supported for AWS provisioned IOPS, or Azure regions that support Extended IOPS. See below.

array

Configuration for the hardware specifications for nodes set for a given region. Each region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below.

object

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling attribute must be the same for all region_configs of a cluster. See below.

object

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below.

object

Configuration for the collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling attribute must be the same for all region_configs of a cluster. See below.

object

Hardware specifications for electable nodes in the region. All electable_specs in the region_configs of a replication_specs must have the same instance_size. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below.

priority
number
object

Hardware specifications for read-only nodes in the region. All read_only_specs in the region_configs of a replication_specs must have the same instance_size as electable_specs. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below.

zoneName
string
tags
object
timeouts
object

(Attributes) (see below for nested schema)

create
string
delete
string
update
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

AdvancedClusterStatus defines the observed state of AdvancedCluster.

object

(No description available)

object

(No description available)

array

The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_mode is set to CUSTOM. The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when tls_cipher_config_mode is set to CUSTOM.

array

The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when tls_cipher_config_mode is set to CUSTOM. The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when tls_cipher_config_mode is set to CUSTOM.

object

Configuration settings applied to BI Connector for Atlas on this cluster. The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters. The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector. See below.

clusterId
string
object

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
object
name
string
paused
boolean
pinnedFcv
object

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

List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. The replication_specs configuration for all shards within the same zone must be the same, with the exception of instance_size and disk_iops that can scale independently. Note that independent disk_iops values are only supported for AWS provisioned IOPS, or Azure regions that support Extended IOPS. See below.

array

Configuration for the hardware specifications for nodes set for a given region. Each region_configs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each region_configs object must have either an analytics_specs object, electable_specs object, or read_only_specs object. See below.

object

Configuration for the Collection of settings that configures analytics-auto-scaling information for the cluster. The values for the analytics_auto_scaling attribute must be the same for all region_configs of a cluster. See below.

object

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary. If you don't specify this parameter, no analytics nodes deploy to this region. See below.

object

Configuration for the collection of settings that configures auto-scaling information for the cluster. The values for the auto_scaling attribute must be the same for all region_configs of a cluster. See below.

object

Hardware specifications for electable nodes in the region. All electable_specs in the region_configs of a replication_specs must have the same instance_size. Electable nodes can become the primary and can enable local reads. If you do not specify this option, no electable nodes are deployed to the region. See below.

priority
number
object

Hardware specifications for read-only nodes in the region. All read_only_specs in the region_configs of a replication_specs must have the same instance_size as electable_specs. Read-only nodes can become the primary and can enable local reads. If you don't specify this parameter, no read-only nodes are deployed to the region. See below.

zoneId
string
zoneName
string
stateName
string
tags
object
timeouts
object

(Attributes) (see below for nested schema)

create
string
delete
string
update
string
array

Conditions of the resource.

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