Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getFlexCluster
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getFlexCluster

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

    # Data Source: mongodbatlas.FlexCluster

    mongodbatlas.FlexCluster describes a flex cluster.

    RECOMMENDATION: We recommend using the mongodbatlas.AdvancedCluster data source instead of mongodbatlas.FlexCluster data source to retrieve Flex clusters. The mongodbatlas.AdvancedCluster 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 Cluster data source.

    Example Usage

    Using getFlexCluster

    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.

    function getFlexCluster(args: GetFlexClusterArgs, opts?: InvokeOptions): Promise<GetFlexClusterResult>
function getFlexClusterOutput(args: GetFlexClusterOutputArgs, opts?: InvokeOptions): Output<GetFlexClusterResult>
    def get_flex_cluster(name: Optional[str] = None,
                     project_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetFlexClusterResult
def get_flex_cluster_output(name: Optional[pulumi.Input[str]] = None,
                     project_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetFlexClusterResult]
    func LookupFlexCluster(ctx *Context, args *LookupFlexClusterArgs, opts ...InvokeOption) (*LookupFlexClusterResult, error)
func LookupFlexClusterOutput(ctx *Context, args *LookupFlexClusterOutputArgs, opts ...InvokeOption) LookupFlexClusterResultOutput

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

    public static class GetFlexCluster 
{
    public static Task<GetFlexClusterResult> InvokeAsync(GetFlexClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetFlexClusterResult> Invoke(GetFlexClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFlexClusterResult> getFlexCluster(GetFlexClusterArgs args, InvokeOptions options)
public static Output<GetFlexClusterResult> getFlexCluster(GetFlexClusterArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Name string
    Human-readable label that identifies the instance.
    ProjectId string
    Unique 24-hexadecimal character string that identifies the project.
    Name string
    Human-readable label that identifies the instance.
    ProjectId string
    Unique 24-hexadecimal character string that identifies the project.
    name String
    Human-readable label that identifies the instance.
    projectId String
    Unique 24-hexadecimal character string that identifies the project.
    name string
    Human-readable label that identifies the instance.
    projectId string
    Unique 24-hexadecimal character string that identifies the project.
    name str
    Human-readable label that identifies the instance.
    project_id str
    Unique 24-hexadecimal character string that identifies the project.
    name String
    Human-readable label that identifies the instance.
    projectId String
    Unique 24-hexadecimal character string that identifies the project.

    getFlexCluster Result

    The following output properties are available:

    BackupSettings GetFlexClusterBackupSettings
    Flex backup configuration
    ClusterType string
    Flex cluster topology.
    ConnectionStrings GetFlexClusterConnectionStrings
    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 GetFlexClusterProviderSettings
    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 GetFlexClusterBackupSettings
    Flex backup configuration
    ClusterType string
    Flex cluster topology.
    ConnectionStrings GetFlexClusterConnectionStrings
    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 GetFlexClusterProviderSettings
    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 GetFlexClusterBackupSettings
    Flex backup configuration
    clusterType String
    Flex cluster topology.
    connectionStrings GetFlexClusterConnectionStrings
    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 GetFlexClusterProviderSettings
    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 GetFlexClusterBackupSettings
    Flex backup configuration
    clusterType string
    Flex cluster topology.
    connectionStrings GetFlexClusterConnectionStrings
    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 GetFlexClusterProviderSettings
    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 GetFlexClusterBackupSettings
    Flex backup configuration
    cluster_type str
    Flex cluster topology.
    connection_strings GetFlexClusterConnectionStrings
    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 GetFlexClusterProviderSettings
    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.

    Supporting Types

    GetFlexClusterBackupSettings

    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.

    GetFlexClusterConnectionStrings

    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.

    GetFlexClusterProviderSettings

    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.
    mongodbatlas logo
    MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
    pulumi/pulumi-mongodbatlas