mongodbatlas.AdvancedCluster

BiConnectorConfig AdvancedClusterBiConnectorConfig

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

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.

Config Server Management Mode for creating or updating a sharded cluster. Valid values are ATLAS_MANAGED (default) and FIXED_TO_DEDICATED. When configured as ATLAS_MANAGED, Atlas may automatically switch the cluster's config server type for optimal performance and savings. When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. To learn more, see the Sharded Cluster Config Servers documentation.

DiskSizeGb double

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (4 TB). This value must be a positive number. You can't set this value with clusters with local NVMe SSDs. The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value. If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095). Atlas calculates storage charges differently depending on whether you choose the default value or a custom value. The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier. If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved. (DEPRECATED) Use replication_specs.#.region_configs.#.(analytics_specs|electable_specs|read_only_specs).disk_size_gb instead. To learn more, see the 1.18.0 upgrade guide.

Deprecated: This parameter is deprecated. Please refer to our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide

Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see Encryption at Rest using Customer Key Management for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For Documentation, see AWS, GCP and Azure. Requirements are if replication_specs.#.region_configs.#.<type>Specs.instance_size is M10 or greater and backup_enabled is false or omitted.

Labels List<AdvancedClusterLabel>

Flag that indicates if cluster uses Atlas-Managed Sharding (false, default) or Self-Managed Sharding (true). It can only be enabled for Global Clusters (GEOSHARDED). It cannot be changed once the cluster is created. Use this mode if you're an advanced user and the default configuration is too restrictive for your workload. If you select this option, you must manually configure the sharding strategy, more information here.

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.

PinnedFcv AdvancedClusterPinnedFcv

Version of the cluster to deploy. Atlas supports all the MongoDB versions that have not reached End of Live for M10+ clusters. If omitted, Atlas deploys the cluster with the default version. For more details, see documentation. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set version_release_system CONTINUOUS, the resource returns an error. Either clear this parameter or set version_release_system: LTS.

Name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed. WARNING Changing the name will result in destruction of the existing cluster and the creation of a new cluster.

Paused bool

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 bool

Flag that indicates if the cluster uses Continuous Cloud Backup.

Flag that enables or disables log redaction, see the manual for more information. Use this in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. Note: Changing this setting on a cluster will trigger a rolling restart as soon as the cluster is updated.

Replica set scaling mode for your cluster. Valid values are WORKLOAD_TYPE, SEQUENTIAL and NODE_TYPE. By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. Modify the Replica Set Scaling Mode

Tags List<AdvancedClusterTag>

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

RootCertType string

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

ReplicationSpecs []AdvancedClusterReplicationSpecArgs

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

ClusterType string

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

ProjectId string

Unique ID for the project to create the cluster.

AcceptDataRisksAndForceReplicaSetReconfig string

AdvancedConfiguration AdvancedClusterAdvancedConfigurationArgs

BiConnectorConfig AdvancedClusterBiConnectorConfigArgs

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

DiskSizeGb float64

Labels []AdvancedClusterLabelArgs

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.

PinnedFcv AdvancedClusterPinnedFcvArgs

Name string

Paused bool

PitEnabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup.

Tags []AdvancedClusterTagArgs

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

RootCertType string

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

replicationSpecs List<AdvancedClusterReplicationSpec>

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

clusterType String

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

projectId String

Unique ID for the project to create the cluster.

acceptDataRisksAndForceReplicaSetReconfig String

advancedConfiguration AdvancedClusterAdvancedConfiguration

backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

biConnectorConfig AdvancedClusterBiConnectorConfig

diskSizeGb Double

labels List<AdvancedClusterLabel>

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.

name String

paused Boolean

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup.

tags List<AdvancedClusterTag>

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

rootCertType String

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

replicationSpecs AdvancedClusterReplicationSpec[]

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

clusterType string

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

projectId string

Unique ID for the project to create the cluster.

acceptDataRisksAndForceReplicaSetReconfig string

advancedConfiguration AdvancedClusterAdvancedConfiguration

backupEnabled boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

biConnectorConfig AdvancedClusterBiConnectorConfig

configServerManagementMode string

diskSizeGb number

encryptionAtRestProvider string

globalClusterSelfManagedSharding boolean

labels AdvancedClusterLabel[]

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.

mongoDbMajorVersion string

name string

paused boolean

tags AdvancedClusterTag[]

pitEnabled boolean

Flag that indicates if the cluster uses Continuous Cloud Backup.

redactClientLogData boolean

replicaSetScalingStrategy string

retainBackupsEnabled boolean

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

rootCertType string

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

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

terminationProtectionEnabled boolean

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

versionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

cluster_type str

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

project_id str

Unique ID for the project to create the cluster.

replication_specs Sequence[AdvancedClusterReplicationSpecArgs]

accept_data_risks_and_force_replica_set_reconfig str

advanced_configuration AdvancedClusterAdvancedConfigurationArgs

backup_enabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

bi_connector_config AdvancedClusterBiConnectorConfigArgs

config_server_management_mode str

disk_size_gb float

encryption_at_rest_provider str

global_cluster_self_managed_sharding bool

labels Sequence[AdvancedClusterLabelArgs]

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.

mongo_db_major_version str

name str

paused bool

pinned_fcv AdvancedClusterPinnedFcvArgs

pit_enabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup.

redact_client_log_data bool

replica_set_scaling_strategy str

retain_backups_enabled bool

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

root_cert_type str

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

tags Sequence[AdvancedClusterTagArgs]

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

termination_protection_enabled bool

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

version_release_system str

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

clusterType String

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

projectId String

Unique ID for the project to create the cluster.

replicationSpecs List<Property Map>

acceptDataRisksAndForceReplicaSetReconfig String

advancedConfiguration Property Map

backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

biConnectorConfig Property Map

diskSizeGb Number

labels List<Property Map>

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.

pinnedFcv Property Map

name String

paused Boolean

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup.

tags List<Property Map>

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

rootCertType String

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

ConnectionStrings List<AdvancedClusterConnectionString>

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

Outputs

All input properties are implicitly available as output properties. Additionally, the AdvancedCluster resource produces the following output properties:

ClusterId string

The cluster ID.

ConfigServerType string

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

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.

CreateDate string

Id string

The provider-assigned unique ID for this managed resource.

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

ClusterId string

The cluster ID.

ConfigServerType string

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

ConnectionStrings []AdvancedClusterConnectionString

CreateDate string

Id string

The provider-assigned unique ID for this managed resource.

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

clusterId String

The cluster ID.

configServerType String

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

connectionStrings List<AdvancedClusterConnectionString>

createDate String

id String

The provider-assigned unique ID for this managed resource.

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

stateName String

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

clusterId string

The cluster ID.

configServerType string

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

connectionStrings AdvancedClusterConnectionString[]

createDate string

id string

The provider-assigned unique ID for this managed resource.

mongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

stateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

cluster_id str

The cluster ID.

config_server_type str

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

connection_strings Sequence[AdvancedClusterConnectionString]

create_date str

id str

The provider-assigned unique ID for this managed resource.

mongo_db_version str

Version of MongoDB the cluster runs, in major-version.minor-version format.

state_name str

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

clusterId String

The cluster ID.

configServerType String

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

connectionStrings List<Property Map>

createDate String

id String

The provider-assigned unique ID for this managed resource.

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

stateName String

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

Look up Existing AdvancedCluster Resource

Get an existing AdvancedCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AdvancedClusterState, opts?: CustomResourceOptions): AdvancedCluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accept_data_risks_and_force_replica_set_reconfig: Optional[str] = None,
        advanced_configuration: Optional[AdvancedClusterAdvancedConfigurationArgs] = None,
        backup_enabled: Optional[bool] = None,
        bi_connector_config: Optional[AdvancedClusterBiConnectorConfigArgs] = None,
        cluster_id: Optional[str] = None,
        cluster_type: Optional[str] = None,
        config_server_management_mode: Optional[str] = None,
        config_server_type: Optional[str] = None,
        connection_strings: Optional[Sequence[AdvancedClusterConnectionStringArgs]] = None,
        create_date: Optional[str] = None,
        disk_size_gb: Optional[float] = None,
        encryption_at_rest_provider: Optional[str] = None,
        global_cluster_self_managed_sharding: Optional[bool] = None,
        labels: Optional[Sequence[AdvancedClusterLabelArgs]] = None,
        mongo_db_major_version: Optional[str] = None,
        mongo_db_version: Optional[str] = None,
        name: Optional[str] = None,
        paused: Optional[bool] = None,
        pinned_fcv: Optional[AdvancedClusterPinnedFcvArgs] = None,
        pit_enabled: Optional[bool] = None,
        project_id: Optional[str] = None,
        redact_client_log_data: Optional[bool] = None,
        replica_set_scaling_strategy: Optional[str] = None,
        replication_specs: Optional[Sequence[AdvancedClusterReplicationSpecArgs]] = None,
        retain_backups_enabled: Optional[bool] = None,
        root_cert_type: Optional[str] = None,
        state_name: Optional[str] = None,
        tags: Optional[Sequence[AdvancedClusterTagArgs]] = None,
        termination_protection_enabled: Optional[bool] = None,
        version_release_system: Optional[str] = None) -> AdvancedCluster

func GetAdvancedCluster(ctx *Context, name string, id IDInput, state *AdvancedClusterState, opts ...ResourceOption) (*AdvancedCluster, error)

public static AdvancedCluster Get(string name, Input<string> id, AdvancedClusterState? state, CustomResourceOptions? opts = null)

public static AdvancedCluster get(String name, Output<String> id, AdvancedClusterState state, CustomResourceOptions options)

resources:  _:    type: mongodbatlas:AdvancedCluster    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AcceptDataRisksAndForceReplicaSetReconfig string

AdvancedConfiguration AdvancedClusterAdvancedConfiguration

BiConnectorConfig AdvancedClusterBiConnectorConfig

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

ClusterId string

The cluster ID.

ClusterType string

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

ConnectionStrings List<AdvancedClusterConnectionString>

ConfigServerType string

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

CreateDate string

DiskSizeGb double

Labels List<AdvancedClusterLabel>

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.

PinnedFcv AdvancedClusterPinnedFcv

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

Name string

Paused bool

PitEnabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup.

ProjectId string

Unique ID for the project to create the cluster.

ReplicationSpecs List<AdvancedClusterReplicationSpec>

Tags List<AdvancedClusterTag>

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

RootCertType string

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

AdvancedConfiguration AdvancedClusterAdvancedConfigurationArgs

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

AcceptDataRisksAndForceReplicaSetReconfig string

BiConnectorConfig AdvancedClusterBiConnectorConfigArgs

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

ClusterId string

The cluster ID.

ClusterType string

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

ConnectionStrings []AdvancedClusterConnectionStringArgs

ConfigServerType string

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

CreateDate string

DiskSizeGb float64

Labels []AdvancedClusterLabelArgs

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.

PinnedFcv AdvancedClusterPinnedFcvArgs

MongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

Name string

Paused bool

PitEnabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup.

ProjectId string

Unique ID for the project to create the cluster.

ReplicationSpecs []AdvancedClusterReplicationSpecArgs

Tags []AdvancedClusterTagArgs

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

RootCertType string

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

StateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

advancedConfiguration AdvancedClusterAdvancedConfiguration

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

acceptDataRisksAndForceReplicaSetReconfig String

backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

biConnectorConfig AdvancedClusterBiConnectorConfig

clusterId String

The cluster ID.

clusterType String

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

connectionStrings List<AdvancedClusterConnectionString>

configServerType String

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

createDate String

diskSizeGb Double

labels List<AdvancedClusterLabel>

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.

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

name String

paused Boolean

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup.

projectId String

Unique ID for the project to create the cluster.

replicationSpecs List<AdvancedClusterReplicationSpec>

tags List<AdvancedClusterTag>

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

rootCertType String

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

stateName String

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

advancedConfiguration AdvancedClusterAdvancedConfiguration

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

acceptDataRisksAndForceReplicaSetReconfig string

backupEnabled boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

biConnectorConfig AdvancedClusterBiConnectorConfig

clusterId string

The cluster ID.

clusterType string

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

configServerManagementMode string

configServerType string

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

connectionStrings AdvancedClusterConnectionString[]

createDate string

diskSizeGb number

encryptionAtRestProvider string

globalClusterSelfManagedSharding boolean

labels AdvancedClusterLabel[]

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.

mongoDbMajorVersion string

mongoDbVersion string

Version of MongoDB the cluster runs, in major-version.minor-version format.

name string

paused boolean

replicationSpecs AdvancedClusterReplicationSpec[]

pitEnabled boolean

Flag that indicates if the cluster uses Continuous Cloud Backup.

projectId string

Unique ID for the project to create the cluster.

redactClientLogData boolean

replicaSetScalingStrategy string

retainBackupsEnabled boolean

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

rootCertType string

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

stateName string

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

tags AdvancedClusterTag[]

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

terminationProtectionEnabled boolean

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

versionReleaseSystem string

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

accept_data_risks_and_force_replica_set_reconfig str

advanced_configuration AdvancedClusterAdvancedConfigurationArgs

backup_enabled bool

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

bi_connector_config AdvancedClusterBiConnectorConfigArgs

cluster_id str

The cluster ID.

cluster_type str

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

config_server_management_mode str

config_server_type str

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

connection_strings Sequence[AdvancedClusterConnectionStringArgs]

create_date str

disk_size_gb float

encryption_at_rest_provider str

global_cluster_self_managed_sharding bool

labels Sequence[AdvancedClusterLabelArgs]

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.

mongo_db_major_version str

mongo_db_version str

Version of MongoDB the cluster runs, in major-version.minor-version format.

name str

paused bool

pinned_fcv AdvancedClusterPinnedFcvArgs

pit_enabled bool

Flag that indicates if the cluster uses Continuous Cloud Backup.

project_id str

Unique ID for the project to create the cluster.

redact_client_log_data bool

replica_set_scaling_strategy str

replication_specs Sequence[AdvancedClusterReplicationSpecArgs]

retain_backups_enabled bool

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

root_cert_type str

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

state_name str

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

tags Sequence[AdvancedClusterTagArgs]

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

termination_protection_enabled bool

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

version_release_system str

Release cadence that Atlas uses for this cluster. This parameter defaults to LTS. If you set this field to CONTINUOUS, you must omit the mongo_db_major_version field. Atlas accepts:

CONTINUOUS: Atlas creates your cluster using the most recent MongoDB release. Atlas automatically updates your cluster to the latest major and rapid MongoDB releases as they become available.
LTS: Atlas creates your cluster using the latest patch release of the MongoDB version that you specify in the mongoDBMajorVersion field. Atlas automatically updates your cluster to subsequent patch releases of this MongoDB version. Atlas doesn't update your cluster to newer rapid or major MongoDB releases as they become available.

acceptDataRisksAndForceReplicaSetReconfig String

advancedConfiguration Property Map

backupEnabled Boolean

Flag that indicates whether the cluster can perform backups. If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

Backup uses: Cloud Backups for dedicated clusters. Flex Cluster Backups for flex clusters. If "backup_enabled" is false (default), the cluster doesn't use Atlas backups.

biConnectorConfig Property Map

clusterId String

The cluster ID.

clusterType String

Type of the cluster that you want to create. Accepted values include:

REPLICASET Replica set
SHARDED Sharded cluster
GEOSHARDED Global Cluster

connectionStrings List<Property Map>

configServerType String

Describes a sharded cluster's config server type. Valid values are DEDICATED and EMBEDDED. To learn more, see the Sharded Cluster Config Servers documentation.

createDate String

diskSizeGb Number

labels List<Property Map>

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.

pinnedFcv Property Map

mongoDbVersion String

Version of MongoDB the cluster runs, in major-version.minor-version format.

name String

paused Boolean

pitEnabled Boolean

Flag that indicates if the cluster uses Continuous Cloud Backup.

projectId String

Unique ID for the project to create the cluster.

replicationSpecs List<Property Map>

tags List<Property Map>

Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster

rootCertType String

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

stateName String

Current state of the cluster. The possible states are:

IDLE
CREATING
UPDATING
DELETING
DELETED
REPAIRING

replication_specs.#.container_id - A key-value map of the Network Peering Container ID(s) for the configuration specified in region_configs. The Container ID is the id of the container created when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is "providerName:regionName" = "containerId". Example AWS:US_EAST_1" = "61e0797dde08fb498ca11a71.

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

Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.