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

mongodbatlas.FlexCluster

Explore with Pulumi AI

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

# Resource: mongodbatlas.FlexCluster

mongodbatlas.FlexCluster provides a Flex Cluster resource. The resource lets you create, update, delete and import a flex cluster.

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

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,
                name: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                termination_protection_enabled: Optional[bool] = 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 This property is required. string
The unique name of the resource.
args This property is required. FlexClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. FlexClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FlexClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    TerminationProtectionEnabled = false,
});
Copy
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"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TerminationProtectionEnabled: pulumi.Bool(false),
})
Copy
var flexClusterResource = new FlexCluster("flexClusterResource", FlexClusterArgs.builder()
    .projectId("string")
    .providerSettings(FlexClusterProviderSettingsArgs.builder()
        .backingProviderName("string")
        .regionName("string")
        .diskSizeGb(0)
        .providerName("string")
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .terminationProtectionEnabled(false)
    .build());
Copy
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",
    },
    name="string",
    tags={
        "string": "string",
    },
    termination_protection_enabled=False)
Copy
const flexClusterResource = new mongodbatlas.FlexCluster("flexClusterResource", {
    projectId: "string",
    providerSettings: {
        backingProviderName: "string",
        regionName: "string",
        diskSizeGb: 0,
        providerName: "string",
    },
    name: "string",
    tags: {
        string: "string",
    },
    terminationProtectionEnabled: false,
});
Copy
type: mongodbatlas:FlexCluster
properties:
    name: string
    projectId: string
    providerSettings:
        backingProviderName: string
        diskSizeGb: 0
        providerName: string
        regionName: string
    tags:
        string: string
    terminationProtectionEnabled: false
Copy

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 This property is required. string
Unique 24-hexadecimal character string that identifies the project.
ProviderSettings This property is required. FlexClusterProviderSettings
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
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.
ProjectId This property is required. string
Unique 24-hexadecimal character string that identifies the project.
ProviderSettings This property is required. FlexClusterProviderSettingsArgs
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
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.
projectId This property is required. String
Unique 24-hexadecimal character string that identifies the project.
providerSettings This property is required. FlexClusterProviderSettings
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
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.
projectId This property is required. string
Unique 24-hexadecimal character string that identifies the project.
providerSettings This property is required. FlexClusterProviderSettings
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
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.
project_id This property is required. str
Unique 24-hexadecimal character string that identifies the project.
provider_settings This property is required. FlexClusterProviderSettingsArgs
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
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.
projectId This property is required. String
Unique 24-hexadecimal character string that identifies the project.
providerSettings This property is required. Property Map
Group of cloud provider settings that configure the provisioned MongoDB flex cluster.
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.

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,
        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,
        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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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

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 This property is required. string
Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
RegionName This property is required. 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 This property is required. string
Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
RegionName This property is required. 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 This property is required. String
Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
regionName This property is required. 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 This property is required. string
Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
regionName This property is required. 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 This property is required. str
Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
region_name This property is required. 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 This property is required. String
Cloud service provider on which MongoDB Cloud provisioned the flex cluster.
regionName This property is required. 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.

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