MongoDB Atlas v3.30.0, Mar 21 25

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getFlexClusters

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

# Data Source: mongodbatlas.getFlexClusters

mongodbatlas.getFlexClusters returns all flex clusters in a project.

RECOMMENDATION: We recommend using the mongodbatlas.getAdvancedClusters data source instead of the mongodbatlas.getFlexClusters data source to retrieve Flex clusters. The mongodbatlas.getAdvancedClusters data source not only supports Flex clusters, but also supports free and dedicated clusters, providing easier migration between different cluster types. For more information, see the Advanced Clusters data source.

Example Usage

Using getFlexClusters

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getFlexClusters(args: GetFlexClustersArgs, opts?: InvokeOptions): Promise<GetFlexClustersResult>
function getFlexClustersOutput(args: GetFlexClustersOutputArgs, opts?: InvokeOptions): Output<GetFlexClustersResult>

def get_flex_clusters(project_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetFlexClustersResult
def get_flex_clusters_output(project_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetFlexClustersResult]

func LookupFlexClusters(ctx *Context, args *LookupFlexClustersArgs, opts ...InvokeOption) (*LookupFlexClustersResult, error)
func LookupFlexClustersOutput(ctx *Context, args *LookupFlexClustersOutputArgs, opts ...InvokeOption) LookupFlexClustersResultOutput

> Note: This function is named LookupFlexClusters in the Go SDK.

public static class GetFlexClusters 
{
    public static Task<GetFlexClustersResult> InvokeAsync(GetFlexClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetFlexClustersResult> Invoke(GetFlexClustersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFlexClustersResult> getFlexClusters(GetFlexClustersArgs args, InvokeOptions options)
public static Output<GetFlexClustersResult> getFlexClusters(GetFlexClustersArgs args, InvokeOptions options)

fn::invoke:
  function: mongodbatlas:index/getFlexClusters:getFlexClusters
  arguments:
    # arguments dictionary

The following arguments are supported:

ProjectId string: Unique 24-hexadecimal character string that identifies the project.

ProjectId string: Unique 24-hexadecimal character string that identifies the project.

projectId String: Unique 24-hexadecimal character string that identifies the project.

projectId string: Unique 24-hexadecimal character string that identifies the project.

project_id str: Unique 24-hexadecimal character string that identifies the project.

projectId String: Unique 24-hexadecimal character string that identifies the project.

getFlexClusters Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: Unique 24-hexadecimal character string that identifies the project.
Results List<GetFlexClustersResult>: List of documents that MongoDB Cloud returns for this request.

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: Unique 24-hexadecimal character string that identifies the project.
Results []GetFlexClustersResult: List of documents that MongoDB Cloud returns for this request.

id String: The provider-assigned unique ID for this managed resource.
projectId String: Unique 24-hexadecimal character string that identifies the project.
results List<GetFlexClustersResult>: List of documents that MongoDB Cloud returns for this request.

id string: The provider-assigned unique ID for this managed resource.
projectId string: Unique 24-hexadecimal character string that identifies the project.
results GetFlexClustersResult[]: List of documents that MongoDB Cloud returns for this request.

id str: The provider-assigned unique ID for this managed resource.
project_id str: Unique 24-hexadecimal character string that identifies the project.
results Sequence[GetFlexClustersResult]: List of documents that MongoDB Cloud returns for this request.

id String: The provider-assigned unique ID for this managed resource.
projectId String: Unique 24-hexadecimal character string that identifies the project.
results List<Property Map>: List of documents that MongoDB Cloud returns for this request.

Supporting Types

GetFlexClustersResult

BackupSettings GetFlexClustersResultBackupSettings: Flex backup configuration
ClusterType string: Flex cluster topology.
ConnectionStrings GetFlexClustersResultConnectionStrings: Collection of Uniform Resource Locators that point to the MongoDB database.
CreateDate string: Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
Id string: Unique 24-hexadecimal digit string that identifies the instance.
MongoDbVersion string: Version of MongoDB that the instance runs.
Name string: Human-readable label that identifies the instance.
ProjectId string: Unique 24-hexadecimal character string that identifies the project.
ProviderSettings GetFlexClustersResultProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
StateName string: Human-readable label that indicates the current operating condition of this instance.
Tags Dictionary<string, string>: Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
TerminationProtectionEnabled 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.
VersionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

BackupSettings GetFlexClustersResultBackupSettings: Flex backup configuration
ClusterType string: Flex cluster topology.
ConnectionStrings GetFlexClustersResultConnectionStrings: Collection of Uniform Resource Locators that point to the MongoDB database.
CreateDate string: Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
Id string: Unique 24-hexadecimal digit string that identifies the instance.
MongoDbVersion string: Version of MongoDB that the instance runs.
Name string: Human-readable label that identifies the instance.
ProjectId string: Unique 24-hexadecimal character string that identifies the project.
ProviderSettings GetFlexClustersResultProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
StateName string: Human-readable label that indicates the current operating condition of this instance.
Tags map[string]string: Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
TerminationProtectionEnabled 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.
VersionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

backupSettings GetFlexClustersResultBackupSettings: Flex backup configuration
clusterType String: Flex cluster topology.
connectionStrings GetFlexClustersResultConnectionStrings: Collection of Uniform Resource Locators that point to the MongoDB database.
createDate String: Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
id String: Unique 24-hexadecimal digit string that identifies the instance.
mongoDbVersion String: Version of MongoDB that the instance runs.
name String: Human-readable label that identifies the instance.
projectId String: Unique 24-hexadecimal character string that identifies the project.
providerSettings GetFlexClustersResultProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
stateName String: Human-readable label that indicates the current operating condition of this instance.
tags Map<String,String>: Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
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: Method by which the cluster maintains the MongoDB versions.

backupSettings GetFlexClustersResultBackupSettings: Flex backup configuration
clusterType string: Flex cluster topology.
connectionStrings GetFlexClustersResultConnectionStrings: Collection of Uniform Resource Locators that point to the MongoDB database.
createDate string: Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
id string: Unique 24-hexadecimal digit string that identifies the instance.
mongoDbVersion string: Version of MongoDB that the instance runs.
name string: Human-readable label that identifies the instance.
projectId string: Unique 24-hexadecimal character string that identifies the project.
providerSettings GetFlexClustersResultProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
stateName string: Human-readable label that indicates the current operating condition of this instance.
tags {[key: string]: string}: Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
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: Method by which the cluster maintains the MongoDB versions.

backup_settings GetFlexClustersResultBackupSettings: Flex backup configuration
cluster_type str: Flex cluster topology.
connection_strings GetFlexClustersResultConnectionStrings: Collection of Uniform Resource Locators that point to the MongoDB database.
create_date str: Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
id str: Unique 24-hexadecimal digit string that identifies the instance.
mongo_db_version str: Version of MongoDB that the instance runs.
name str: Human-readable label that identifies the instance.
project_id str: Unique 24-hexadecimal character string that identifies the project.
provider_settings GetFlexClustersResultProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
state_name str: Human-readable label that indicates the current operating condition of this instance.
tags Mapping[str, str]: Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
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: Method by which the cluster maintains the MongoDB versions.

backupSettings Property Map: Flex backup configuration
clusterType String: Flex cluster topology.
connectionStrings Property Map: Collection of Uniform Resource Locators that point to the MongoDB database.
createDate String: Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.
id String: Unique 24-hexadecimal digit string that identifies the instance.
mongoDbVersion String: Version of MongoDB that the instance runs.
name String: Human-readable label that identifies the instance.
projectId String: Unique 24-hexadecimal character string that identifies the project.
providerSettings Property Map: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
stateName String: Human-readable label that indicates the current operating condition of this instance.
tags Map<String>: Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.
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: Method by which the cluster maintains the MongoDB versions.

GetFlexClustersResultBackupSettings

Enabled bool: Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.

Enabled bool: Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.

enabled Boolean: Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.

enabled boolean: Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.

enabled bool: Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.

enabled Boolean: Flag that indicates whether backups are performed for this flex cluster. Backup uses flex cluster backups.

GetFlexClustersResultConnectionStrings

Standard string: Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
StandardSrv string: Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.

Standard string: Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
StandardSrv string: Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.

standard String: Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
standardSrv String: Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.

standard string: Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
standardSrv string: Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.

standard str: Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
standard_srv str: Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.

standard String: Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.
standardSrv String: Public connection string that you can use to connect to this flex cluster. This connection string uses the mongodb+srv:// protocol.

GetFlexClustersResultProviderSettings

BackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
DiskSizeGb double: Storage capacity available to the flex cluster expressed in gigabytes.
ProviderName string: Human-readable label that identifies the cloud service provider.
RegionName string: Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

BackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
DiskSizeGb float64: Storage capacity available to the flex cluster expressed in gigabytes.
ProviderName string: Human-readable label that identifies the cloud service provider.
RegionName string: Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

backingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
diskSizeGb Double: Storage capacity available to the flex cluster expressed in gigabytes.
providerName String: Human-readable label that identifies the cloud service provider.
regionName String: Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

backingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
diskSizeGb number: Storage capacity available to the flex cluster expressed in gigabytes.
providerName string: Human-readable label that identifies the cloud service provider.
regionName string: Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

backing_provider_name str: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
disk_size_gb float: Storage capacity available to the flex cluster expressed in gigabytes.
provider_name str: Human-readable label that identifies the cloud service provider.
region_name str: Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

backingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
diskSizeGb Number: Storage capacity available to the flex cluster expressed in gigabytes.
providerName String: Human-readable label that identifies the cloud service provider.
regionName String: Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see AWS, GCP, and Azure.

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getFlexClusters

On this page

On this page

# Data Source: mongodbatlas.getFlexClusters

Example Usage

Using getFlexClusters

getFlexClusters Result

Supporting Types

GetFlexClustersResult

GetFlexClustersResultBackupSettings

GetFlexClustersResultConnectionStrings

GetFlexClustersResultProviderSettings

Package Details

On this page

On this page