FlexCluster

MongoDB Atlas v4.2.0, Jan 23 26

MongoDB Atlas v4.2.0 published on Friday, Jan 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

MongoDB Atlas v4.2.0 published on Friday, Jan 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

RECOMMENDATION: We recommend using the mongodbatlas.AdvancedCluster resource instead of the mongodbatlas.FlexCluster resource to create and manage Flex clusters. The mongodbatlas.AdvancedCluster resource not only supports Flex clusters, but also supports tenant and dedicated clusters, providing easier migration between different cluster types. For more information, see the Advanced Cluster resource.

Example Usage

S

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const example_clusterFlexCluster = new mongodbatlas.FlexCluster("example-cluster", {
    projectId: projectId,
    name: clusterName,
    providerSettings: {
        backingProviderName: "AWS",
        regionName: "US_EAST_1",
    },
    terminationProtectionEnabled: true,
});
const example_cluster = example_clusterFlexCluster.name.apply(name => mongodbatlas.getFlexClusterOutput({
    projectId: projectId,
    name: name,
}));
const example_clusters = mongodbatlas.getFlexClusters({
    projectId: projectId,
});
export const mongodbatlasFlexCluster = example_cluster.apply(example_cluster => example_cluster.name);
export const mongodbatlasFlexClustersNames = example_clusters.then(example_clusters => .map(cluster => (cluster.name)));

import pulumi
import pulumi_mongodbatlas as mongodbatlas

example_cluster_flex_cluster = mongodbatlas.FlexCluster("example-cluster",
    project_id=project_id,
    name=cluster_name,
    provider_settings={
        "backing_provider_name": "AWS",
        "region_name": "US_EAST_1",
    },
    termination_protection_enabled=True)
example_cluster = example_cluster_flex_cluster.name.apply(lambda name: mongodbatlas.get_flex_cluster_output(project_id=project_id,
    name=name))
example_clusters = mongodbatlas.get_flex_clusters(project_id=project_id)
pulumi.export("mongodbatlasFlexCluster", example_cluster.name)
pulumi.export("mongodbatlasFlexClustersNames", [cluster.name for cluster in example_clusters.results])

Example coming soon!

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var example_clusterFlexCluster = new Mongodbatlas.FlexCluster("example-cluster", new()
    {
        ProjectId = projectId,
        Name = clusterName,
        ProviderSettings = new Mongodbatlas.Inputs.FlexClusterProviderSettingsArgs
        {
            BackingProviderName = "AWS",
            RegionName = "US_EAST_1",
        },
        TerminationProtectionEnabled = true,
    });

    var example_cluster = Mongodbatlas.GetFlexCluster.Invoke(new()
    {
        ProjectId = projectId,
        Name = example_clusterFlexCluster.Name,
    });

    var example_clusters = Mongodbatlas.GetFlexClusters.Invoke(new()
    {
        ProjectId = projectId,
    });

    return new Dictionary<string, object?>
    {
        ["mongodbatlasFlexCluster"] = example_cluster.Apply(example_cluster => example_cluster.Apply(getFlexClusterResult => getFlexClusterResult.Name)),
        ["mongodbatlasFlexClustersNames"] = example_clusters.Apply(example_clusters => .Select(cluster => 
        {
            return cluster.Name;
        }).ToList()),
    };
});

Example coming soon!

Example coming soon!

Further Examples

Flex Cluster

Create FlexCluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FlexCluster(name: string, args: FlexClusterArgs, opts?: CustomResourceOptions);

@overload
def FlexCluster(resource_name: str,
                args: FlexClusterArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def FlexCluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                project_id: Optional[str] = None,
                provider_settings: Optional[FlexClusterProviderSettingsArgs] = None,
                delete_on_create_timeout: Optional[bool] = None,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                termination_protection_enabled: Optional[bool] = None,
                timeouts: Optional[FlexClusterTimeoutsArgs] = None)

func NewFlexCluster(ctx *Context, name string, args FlexClusterArgs, opts ...ResourceOption) (*FlexCluster, error)

public FlexCluster(string name, FlexClusterArgs args, CustomResourceOptions? opts = null)

public FlexCluster(String name, FlexClusterArgs args)
public FlexCluster(String name, FlexClusterArgs args, CustomResourceOptions options)

type: mongodbatlas:FlexCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args FlexClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args FlexClusterArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args FlexClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FlexClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FlexClusterArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var flexClusterResource = new Mongodbatlas.FlexCluster("flexClusterResource", new()
{
    ProjectId = "string",
    ProviderSettings = new Mongodbatlas.Inputs.FlexClusterProviderSettingsArgs
    {
        BackingProviderName = "string",
        RegionName = "string",
        DiskSizeGb = 0,
        ProviderName = "string",
    },
    DeleteOnCreateTimeout = false,
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TerminationProtectionEnabled = false,
    Timeouts = new Mongodbatlas.Inputs.FlexClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

example, err := mongodbatlas.NewFlexCluster(ctx, "flexClusterResource", &mongodbatlas.FlexClusterArgs{
	ProjectId: pulumi.String("string"),
	ProviderSettings: &mongodbatlas.FlexClusterProviderSettingsArgs{
		BackingProviderName: pulumi.String("string"),
		RegionName:          pulumi.String("string"),
		DiskSizeGb:          pulumi.Float64(0),
		ProviderName:        pulumi.String("string"),
	},
	DeleteOnCreateTimeout: pulumi.Bool(false),
	Name:                  pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TerminationProtectionEnabled: pulumi.Bool(false),
	Timeouts: &mongodbatlas.FlexClusterTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

var flexClusterResource = new FlexCluster("flexClusterResource", FlexClusterArgs.builder()
    .projectId("string")
    .providerSettings(FlexClusterProviderSettingsArgs.builder()
        .backingProviderName("string")
        .regionName("string")
        .diskSizeGb(0.0)
        .providerName("string")
        .build())
    .deleteOnCreateTimeout(false)
    .name("string")
    .tags(Map.of("string", "string"))
    .terminationProtectionEnabled(false)
    .timeouts(FlexClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

flex_cluster_resource = mongodbatlas.FlexCluster("flexClusterResource",
    project_id="string",
    provider_settings={
        "backing_provider_name": "string",
        "region_name": "string",
        "disk_size_gb": 0,
        "provider_name": "string",
    },
    delete_on_create_timeout=False,
    name="string",
    tags={
        "string": "string",
    },
    termination_protection_enabled=False,
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

const flexClusterResource = new mongodbatlas.FlexCluster("flexClusterResource", {
    projectId: "string",
    providerSettings: {
        backingProviderName: "string",
        regionName: "string",
        diskSizeGb: 0,
        providerName: "string",
    },
    deleteOnCreateTimeout: false,
    name: "string",
    tags: {
        string: "string",
    },
    terminationProtectionEnabled: false,
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

type: mongodbatlas:FlexCluster
properties:
    deleteOnCreateTimeout: false
    name: string
    projectId: string
    providerSettings:
        backingProviderName: string
        diskSizeGb: 0
        providerName: string
        regionName: string
    tags:
        string: string
    terminationProtectionEnabled: false
    timeouts:
        create: string
        delete: string
        update: string

FlexCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FlexCluster resource accepts the following input properties:

ProjectId string: Unique 24-hexadecimal character string that identifies the project.
ProviderSettings FlexClusterProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
DeleteOnCreateTimeout bool: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
Name string: Human-readable label that identifies the 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.
Timeouts FlexClusterTimeouts

ProjectId string: Unique 24-hexadecimal character string that identifies the project.
ProviderSettings FlexClusterProviderSettingsArgs: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
DeleteOnCreateTimeout bool: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
Name string: Human-readable label that identifies the 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.
Timeouts FlexClusterTimeoutsArgs

projectId String: Unique 24-hexadecimal character string that identifies the project.
providerSettings FlexClusterProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
deleteOnCreateTimeout Boolean: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
name String: Human-readable label that identifies the 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.
timeouts FlexClusterTimeouts

projectId string: Unique 24-hexadecimal character string that identifies the project.
providerSettings FlexClusterProviderSettings: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
deleteOnCreateTimeout boolean: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
name string: Human-readable label that identifies the 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.
timeouts FlexClusterTimeouts

project_id str: Unique 24-hexadecimal character string that identifies the project.
provider_settings FlexClusterProviderSettingsArgs: Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
delete_on_create_timeout bool: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
name str: Human-readable label that identifies the 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.
timeouts FlexClusterTimeoutsArgs

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.
deleteOnCreateTimeout Boolean: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
name String: Human-readable label that identifies the 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.
timeouts Property Map

Outputs

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

BackupSettings FlexClusterBackupSettings: Flex backup configuration
ClusterType string: Flex cluster topology.
ConnectionStrings FlexClusterConnectionStrings: 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: The provider-assigned unique ID for this managed resource.
MongoDbVersion string: Version of MongoDB that the instance runs.
StateName string: Human-readable label that indicates the current operating condition of this instance.
VersionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

BackupSettings FlexClusterBackupSettings: Flex backup configuration
ClusterType string: Flex cluster topology.
ConnectionStrings FlexClusterConnectionStrings: 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: The provider-assigned unique ID for this managed resource.
MongoDbVersion string: Version of MongoDB that the instance runs.
StateName string: Human-readable label that indicates the current operating condition of this instance.
VersionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

backupSettings FlexClusterBackupSettings: Flex backup configuration
clusterType String: Flex cluster topology.
connectionStrings FlexClusterConnectionStrings: 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: The provider-assigned unique ID for this managed resource.
mongoDbVersion String: Version of MongoDB that the instance runs.
stateName String: Human-readable label that indicates the current operating condition of this instance.
versionReleaseSystem String: Method by which the cluster maintains the MongoDB versions.

backupSettings FlexClusterBackupSettings: Flex backup configuration
clusterType string: Flex cluster topology.
connectionStrings FlexClusterConnectionStrings: 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: The provider-assigned unique ID for this managed resource.
mongoDbVersion string: Version of MongoDB that the instance runs.
stateName string: Human-readable label that indicates the current operating condition of this instance.
versionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

backup_settings FlexClusterBackupSettings: Flex backup configuration
cluster_type str: Flex cluster topology.
connection_strings FlexClusterConnectionStrings: 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: The provider-assigned unique ID for this managed resource.
mongo_db_version str: Version of MongoDB that the instance runs.
state_name str: Human-readable label that indicates the current operating condition of this instance.
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: The provider-assigned unique ID for this managed resource.
mongoDbVersion String: Version of MongoDB that the instance runs.
stateName String: Human-readable label that indicates the current operating condition of this instance.
versionReleaseSystem String: Method by which the cluster maintains the MongoDB versions.

Look up Existing FlexCluster Resource

Get an existing FlexCluster 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?: FlexClusterState, opts?: CustomResourceOptions): FlexCluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_settings: Optional[FlexClusterBackupSettingsArgs] = None,
        cluster_type: Optional[str] = None,
        connection_strings: Optional[FlexClusterConnectionStringsArgs] = None,
        create_date: Optional[str] = None,
        delete_on_create_timeout: Optional[bool] = None,
        mongo_db_version: Optional[str] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_settings: Optional[FlexClusterProviderSettingsArgs] = None,
        state_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        termination_protection_enabled: Optional[bool] = None,
        timeouts: Optional[FlexClusterTimeoutsArgs] = None,
        version_release_system: Optional[str] = None) -> FlexCluster

func GetFlexCluster(ctx *Context, name string, id IDInput, state *FlexClusterState, opts ...ResourceOption) (*FlexCluster, error)

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

public static FlexCluster get(String name, Output<String> id, FlexClusterState state, CustomResourceOptions options)

resources:  _:    type: mongodbatlas:FlexCluster    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:

BackupSettings FlexClusterBackupSettings: Flex backup configuration
ClusterType string: Flex cluster topology.
ConnectionStrings FlexClusterConnectionStrings: 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.
DeleteOnCreateTimeout bool: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
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 FlexClusterProviderSettings: 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.
Timeouts FlexClusterTimeouts
VersionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

BackupSettings FlexClusterBackupSettingsArgs: Flex backup configuration
ClusterType string: Flex cluster topology.
ConnectionStrings FlexClusterConnectionStringsArgs: 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.
DeleteOnCreateTimeout bool: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
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 FlexClusterProviderSettingsArgs: 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.
Timeouts FlexClusterTimeoutsArgs
VersionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

backupSettings FlexClusterBackupSettings: Flex backup configuration
clusterType String: Flex cluster topology.
connectionStrings FlexClusterConnectionStrings: 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.
deleteOnCreateTimeout Boolean: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
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 FlexClusterProviderSettings: 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.
timeouts FlexClusterTimeouts
versionReleaseSystem String: Method by which the cluster maintains the MongoDB versions.

backupSettings FlexClusterBackupSettings: Flex backup configuration
clusterType string: Flex cluster topology.
connectionStrings FlexClusterConnectionStrings: 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.
deleteOnCreateTimeout boolean: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
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 FlexClusterProviderSettings: 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.
timeouts FlexClusterTimeouts
versionReleaseSystem string: Method by which the cluster maintains the MongoDB versions.

backup_settings FlexClusterBackupSettingsArgs: Flex backup configuration
cluster_type str: Flex cluster topology.
connection_strings FlexClusterConnectionStringsArgs: 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.
delete_on_create_timeout bool: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
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 FlexClusterProviderSettingsArgs: 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.
timeouts FlexClusterTimeoutsArgs
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.
deleteOnCreateTimeout Boolean: Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
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.
timeouts Property Map
versionReleaseSystem String: Method by which the cluster maintains the MongoDB versions.

Supporting Types

FlexClusterBackupSettings, FlexClusterBackupSettingsArgs

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.

FlexClusterConnectionStrings, FlexClusterConnectionStringsArgs

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.

FlexClusterProviderSettings, FlexClusterProviderSettingsArgs

BackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
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.
DiskSizeGb double: Storage capacity available to the flex cluster expressed in gigabytes.
ProviderName string: Human-readable label that identifies the cloud service provider.

BackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
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.
DiskSizeGb float64: Storage capacity available to the flex cluster expressed in gigabytes.
ProviderName string: Human-readable label that identifies the cloud service provider.

backingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
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.
diskSizeGb Double: Storage capacity available to the flex cluster expressed in gigabytes.
providerName String: Human-readable label that identifies the cloud service provider.

backingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
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.
diskSizeGb number: Storage capacity available to the flex cluster expressed in gigabytes.
providerName string: Human-readable label that identifies the cloud service provider.

backing_provider_name str: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
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.
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.

backingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
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.
diskSizeGb Number: Storage capacity available to the flex cluster expressed in gigabytes.
providerName String: Human-readable label that identifies the cloud service provider.

FlexClusterTimeouts, FlexClusterTimeoutsArgs

Create string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.
Delete string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. Default: 3h.
Update string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.

Create string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.
Delete string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. Default: 3h.
Update string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.

create String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.
delete String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. Default: 3h.
update String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.

create string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.
delete string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. Default: 3h.
update string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.

create str: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.
delete str: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. Default: 3h.
update str: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.

create String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.
delete String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. Default: 3h.
update String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), and "h" (hours). Default: 3h.

Import

You can import the Flex Cluster resource by using the Project ID and Flex Cluster name, in the format PROJECT_ID-FLEX_CLUSTER_NAME. For example:

$ terraform import mongodbatlas_flex_cluster.test 6117ac2fe2a3d04ed27a987v-yourFlexClusterName

For more information see: MongoDB Atlas API - Flex Cluster Documentation.

To learn more about importing existing cloud resources, see Importing resources.

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 v4.2.0 published on Friday, Jan 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-mongodbatlas

mongodbatlas.FlexCluster

On this page

On this page

Example Usage

S

Further Examples

Create FlexCluster Resource

Constructor syntax

Parameters

Constructor example

FlexCluster Resource Properties

Inputs

Outputs

Look up Existing FlexCluster Resource

Supporting Types

FlexClusterBackupSettings, FlexClusterBackupSettingsArgs

FlexClusterConnectionStrings, FlexClusterConnectionStringsArgs

FlexClusterProviderSettings, FlexClusterProviderSettingsArgs

FlexClusterTimeouts, FlexClusterTimeoutsArgs

Import

Package Details

On this page

On this page