GetCluster

func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)

Note: This function is named LookupCluster in the Go SDK.

Name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

ProjectId string

The unique ID for the project to create the database user.

Name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

ProjectId string

The unique ID for the project to create the database user.

name string

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

projectId string

The unique ID for the project to create the database user.

name str

Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.

project_id str

The unique ID for the project to create the database user.

AutoScalingDiskGbEnabled bool

Indicates whether disk auto-scaling is enabled.

BackingProviderName string

Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

BiConnector GetClusterBiConnector

Indicates 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.

ClusterType string

Indicates the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

ConnectionStrings GetClusterConnectionStrings

Set of connection strings that your applications use to connect to this cluster. More info 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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

DiskSizeGb double

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

EncryptionAtRestProvider string

Indicates whether Encryption at Rest is enabled or disabled.

Id string

The provider-assigned unique ID for this managed resource.

Labels List<GetClusterLabel>

MongoDbMajorVersion string

Indicates the version of the cluster to deploy.

MongoDbVersion string

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

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

Name string

The name of the current plugin

NumShards int

Number of shards to deploy in the specified zone.

Paused bool

Flag that indicates whether the cluster is paused or not.

PitEnabled bool

Flag that indicates if the cluster uses Point-in-Time backups.

ProjectId string

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

ProviderDiskIops int

Indicates the maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

ProviderDiskTypeName string

Describes Azure disk type of the server’s root volume (Azure Only).

ProviderEncryptEbsVolume bool

Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance.

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

ProviderName string

Indicates the cloud service provider on which the servers are provisioned.

ProviderRegionName string

Indicates Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas Region name, see the reference list for AWS, GCP, Azure.

ProviderVolumeType string

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

ReplicationFactor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

ReplicationSpecs List<GetClusterReplicationSpec>

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

SnapshotBackupPolicies List<GetClusterSnapshotBackupPolicy>

current snapshot schedule and retention settings for the cluster.

SrvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

StateName string

Indicates the current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

AutoScalingDiskGbEnabled bool

Indicates whether disk auto-scaling is enabled.

BackingProviderName string

Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.

BackupEnabled bool

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

BiConnector GetClusterBiConnector

Indicates 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.

ClusterType string

Indicates the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

ConnectionStrings GetClusterConnectionStrings

Set of connection strings that your applications use to connect to this cluster. More info 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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

DiskSizeGb float64

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

EncryptionAtRestProvider string

Indicates whether Encryption at Rest is enabled or disabled.

Id string

The provider-assigned unique ID for this managed resource.

Labels []GetClusterLabel

MongoDbMajorVersion string

Indicates the version of the cluster to deploy.

MongoDbVersion string

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

MongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

MongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

MongoUriWithOptions string

Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

Name string

The name of the current plugin

NumShards int

Number of shards to deploy in the specified zone.

Paused bool

Flag that indicates whether the cluster is paused or not.

PitEnabled bool

Flag that indicates if the cluster uses Point-in-Time backups.

ProjectId string

ProviderBackupEnabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

ProviderDiskIops int

Indicates the maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

ProviderDiskTypeName string

Describes Azure disk type of the server’s root volume (Azure Only).

ProviderEncryptEbsVolume bool

Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance.

ProviderInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

ProviderName string

Indicates the cloud service provider on which the servers are provisioned.

ProviderRegionName string

Indicates Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas Region name, see the reference list for AWS, GCP, Azure.

ProviderVolumeType string

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

ReplicationFactor int

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

ReplicationSpecs []GetClusterReplicationSpec

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

SnapshotBackupPolicies []GetClusterSnapshotBackupPolicy

current snapshot schedule and retention settings for the cluster.

SrvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

StateName string

Indicates the current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

autoScalingDiskGbEnabled boolean

Indicates whether disk auto-scaling is enabled.

backingProviderName string

Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backupEnabled boolean

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

biConnector GetClusterBiConnector

Indicates 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.

clusterType string

Indicates the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

connectionStrings GetClusterConnectionStrings

Set of connection strings that your applications use to connect to this cluster. More info 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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

diskSizeGb number

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

encryptionAtRestProvider string

Indicates whether Encryption at Rest is enabled or disabled.

id string

The provider-assigned unique ID for this managed resource.

labels GetClusterLabel[]

mongoDbMajorVersion string

Indicates the version of the cluster to deploy.

mongoDbVersion string

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

mongoUri string

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongoUriUpdated string

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongoUriWithOptions string

Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

name string

The name of the current plugin

numShards number

Number of shards to deploy in the specified zone.

paused boolean

Flag that indicates whether the cluster is paused or not.

pitEnabled boolean

Flag that indicates if the cluster uses Point-in-Time backups.

projectId string

providerBackupEnabled boolean

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

providerDiskIops number

Indicates the maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

providerDiskTypeName string

Describes Azure disk type of the server’s root volume (Azure Only).

providerEncryptEbsVolume boolean

Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance.

providerInstanceSizeName string

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

providerName string

Indicates the cloud service provider on which the servers are provisioned.

providerRegionName string

Indicates Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas Region name, see the reference list for AWS, GCP, Azure.

providerVolumeType string

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

replicationFactor number

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

replicationSpecs GetClusterReplicationSpec[]

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

snapshotBackupPolicies GetClusterSnapshotBackupPolicy[]

current snapshot schedule and retention settings for the cluster.

srvAddress string

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

stateName string

Indicates the current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

auto_scaling_disk_gb_enabled bool

Indicates whether disk auto-scaling is enabled.

backing_provider_name str

Indicates Cloud service provider on which the server for a multi-tenant cluster is provisioned.

backup_enabled bool

Legacy Option, Indicates whether Atlas continuous backups are enabled for the cluster.

bi_connector Dict[GetClusterBiConnector]

Indicates 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.

cluster_type str

Indicates the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.

connection_strings Dict[GetClusterConnectionStrings]

Set of connection strings that your applications use to connect to this cluster. More info 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. - connection_strings.standard - Public mongodb:// connection string for this cluster. - connection_strings.standard_srv - Public mongodb+srv:// connection string for this cluster. The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don’t need to append the seed list or change the URI if the nodes change. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.standard. - connection_strings.aws_private_link - Private-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. - connection_strings.aws_private_link_srv - Private-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a AWS PrivateLink connection to this cluster. Use this URI format if your driver supports it. If it doesn’t, use connectionStrings.awsPrivateLink. - connection_strings.private - Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster. - connection_strings.private_srv - Network-peering-endpoint-aware mongodb+srv://connection strings for each interface VPC endpoint you configured to connect to this cluster. Returned only if you created a network peering connection to this cluster.

disk_size_gb float

Indicates the size in gigabytes of the server’s root volume (AWS/GCP Only).

encryption_at_rest_provider str

Indicates whether Encryption at Rest is enabled or disabled.

id str

The provider-assigned unique ID for this managed resource.

labels List[GetClusterLabel]

mongo_db_major_version str

Indicates the version of the cluster to deploy.

mongo_db_version str

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

mongo_uri str

Base connection string for the cluster. Atlas only displays this field after the cluster is operational, not while it builds the cluster.

mongo_uri_updated str

Lists when the connection string was last updated. The connection string changes, for example, if you change a replica set to a sharded cluster.

mongo_uri_with_options str

Describes connection string for connecting to the Atlas cluster. Includes the replicaSet, ssl, and authSource query parameters in the connection string with values appropriate for the cluster.

name str

The name of the current plugin

num_shards float

Number of shards to deploy in the specified zone.

paused bool

Flag that indicates whether the cluster is paused or not.

pit_enabled bool

Flag that indicates if the cluster uses Point-in-Time backups.

project_id str

provider_backup_enabled bool

Flag indicating if the cluster uses Cloud Provider Snapshots for backups.

provider_disk_iops float

Indicates the maximum input/output operations per second (IOPS) the system can perform. The possible values depend on the selected providerSettings.instanceSizeName and diskSizeGB.

provider_disk_type_name str

Describes Azure disk type of the server’s root volume (Azure Only).

provider_encrypt_ebs_volume bool

Indicates whether the Amazon EBS encryption is enabled. This feature encrypts the server’s root volume for both data at rest within the volume and data moving between the volume and the instance.

provider_instance_size_name str

Atlas provides different instance sizes, each with a default storage capacity and RAM size.

provider_name str

Indicates the cloud service provider on which the servers are provisioned.

provider_region_name str

Indicates Physical location of your MongoDB cluster. The region you choose can affect network latency for clients accessing your databases. Requires the Atlas Region name, see the reference list for AWS, GCP, Azure.

provider_volume_type str

Indicates the type of the volume. The possible values are: STANDARD and PROVISIONED.

replication_factor float

Number of replica set members. Each member keeps a copy of your databases, providing high availability and data redundancy. The possible values are 3, 5, or 7. The default value is 3.

replication_specs List[GetClusterReplicationSpec]

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

snapshot_backup_policies List[GetClusterSnapshotBackupPolicy]

current snapshot schedule and retention settings for the cluster.

srv_address str

Connection string for connecting to the Atlas cluster. The +srv modifier forces the connection to use TLS/SSL. See the mongoURI for additional options.

state_name str

Indicates the current state of the cluster. The possible states are: - IDLE - CREATING - UPDATING - DELETING - DELETED - REPAIRING

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Enabled string

Indicates whether or not BI Connector for Atlas is enabled on the cluster.

ReadPreference string

Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

Enabled string

Indicates whether or not BI Connector for Atlas is enabled on the cluster.

ReadPreference string

Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled string

Indicates whether or not BI Connector for Atlas is enabled on the cluster.

readPreference string

Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

enabled str

Indicates whether or not BI Connector for Atlas is enabled on the cluster.

read_preference str

Indicates the read preference to be used by BI Connector for Atlas on the cluster. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options. For details on BI Connector for Atlas read preferences, refer to the BI Connector Read Preferences Table.

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AwsPrivateLink Dictionary<string, object>

AwsPrivateLinkSrv Dictionary<string, object>

Private string

PrivateSrv string

Standard string

StandardSrv string

AwsPrivateLink map[string]interface{}

AwsPrivateLinkSrv map[string]interface{}

Private string

PrivateSrv string

Standard string

StandardSrv string

awsPrivateLink {[key: string]: any}

awsPrivateLinkSrv {[key: string]: any}

private string

privateSrv string

standard string

standardSrv string

awsPrivateLink Dict[str, Any]

awsPrivateLinkSrv Dict[str, Any]

private str

privateSrv str

standard str

standardSrv str

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Key string

The key that was set.

Value string

The value that represents the key.

Key string

The key that was set.

Value string

The value that represents the key.

key string

The key that was set.

value string

The value that represents the key.

key str

The key that was set.

value str

The value that represents the key.

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

NumShards int

Number of shards to deploy in the specified zone.

RegionsConfigs List<GetClusterReplicationSpecRegionsConfigArgs>

Describes the 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

Indicates the n ame for the zone in a Global Cluster.

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

NumShards int

Number of shards to deploy in the specified zone.

RegionsConfigs []GetClusterReplicationSpecRegionsConfig

Describes the 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

Indicates the n ame for the zone in a Global Cluster.

id string

Unique identifer of the replication document for a zone in a Global Cluster.

numShards number

Number of shards to deploy in the specified zone.

regionsConfigs GetClusterReplicationSpecRegionsConfig[]

Describes the 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

Indicates the n ame for the zone in a Global Cluster.

id str

Unique identifer of the replication document for a zone in a Global Cluster.

num_shards float

Number of shards to deploy in the specified zone.

regionsConfigs List[GetClusterReplicationSpecRegionsConfig]

Describes the 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 str

Indicates the n ame for the zone in a Global Cluster.

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AnalyticsNodes int

Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

ElectableNodes int

Number of electable nodes for Atlas to deploy to the region.

Priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0.

ReadOnlyNodes int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

RegionName string

Name for the region specified.

AnalyticsNodes int

Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

ElectableNodes int

Number of electable nodes for Atlas to deploy to the region.

Priority int

Election priority of the region. For regions with only read-only nodes, set this value to 0.

ReadOnlyNodes int

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

RegionName string

Name for the region specified.

analyticsNodes number

Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

electableNodes number

Number of electable nodes for Atlas to deploy to the region.

priority number

Election priority of the region. For regions with only read-only nodes, set this value to 0.

readOnlyNodes number

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

regionName string

Name for the region specified.

analyticsNodes float

Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

electableNodes float

Number of electable nodes for Atlas to deploy to the region.

priority float

Election priority of the region. For regions with only read-only nodes, set this value to 0.

readOnlyNodes float

Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can facilitate local-reads. Specify 0 if you do not want any read-only nodes in the region.

region_name str

Name for the region specified.

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

ClusterId string

ClusterName string

NextSnapshot string

Policies List<GetClusterSnapshotBackupPolicyPolicyArgs>

ReferenceHourOfDay int

ReferenceMinuteOfHour int

RestoreWindowDays int

UpdateSnapshots bool

ClusterId string

ClusterName string

NextSnapshot string

Policies []GetClusterSnapshotBackupPolicyPolicy

ReferenceHourOfDay int

ReferenceMinuteOfHour int

RestoreWindowDays int

UpdateSnapshots bool

clusterId string

clusterName string

nextSnapshot string

policies GetClusterSnapshotBackupPolicyPolicy[]

referenceHourOfDay number

referenceMinuteOfHour number

restoreWindowDays number

updateSnapshots boolean

cluster_id str

cluster_name str

next_snapshot str

policies List[GetClusterSnapshotBackupPolicyPolicy]

reference_hour_of_day float

reference_minute_of_hour float

restore_window_days float

update_snapshots bool

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

PolicyItems List<GetClusterSnapshotBackupPolicyPolicyPolicyItemArgs>

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

PolicyItems []GetClusterSnapshotBackupPolicyPolicyPolicyItem

id string

Unique identifer of the replication document for a zone in a Global Cluster.

policyItems GetClusterSnapshotBackupPolicyPolicyPolicyItem[]

id str

Unique identifer of the replication document for a zone in a Global Cluster.

policyItems List[GetClusterSnapshotBackupPolicyPolicyPolicyItem]

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

FrequencyInterval int

FrequencyType string

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

RetentionUnit string

RetentionValue int

FrequencyInterval int

FrequencyType string

Id string

Unique identifer of the replication document for a zone in a Global Cluster.

RetentionUnit string

RetentionValue int

frequencyInterval number

frequencyType string

id string

Unique identifer of the replication document for a zone in a Global Cluster.

retentionUnit string

retentionValue number

frequencyInterval float

frequencyType str

id str

Unique identifer of the replication document for a zone in a Global Cluster.

retentionUnit str

retentionValue float