1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getProjects
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getProjects

Explore with Pulumi AI

# Data Source: mongodbatlas.getProjects

mongodbatlas.getProjects describes all Projects. This represents projects that have been created.

NOTE: Groups and projects are synonymous terms. You may find groupId in the official documentation.

Example Usage

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

const test = mongodbatlas.getRolesOrgId({});
const testProject = new mongodbatlas.Project("test", {
    name: "project-name",
    orgId: test.then(test => test.orgId),
    teams: [
        {
            teamId: "5e0fa8c99ccf641c722fe645",
            roleNames: ["GROUP_OWNER"],
        },
        {
            teamId: "5e1dd7b4f2a30ba80a70cd4rw",
            roleNames: [
                "GROUP_READ_ONLY",
                "GROUP_DATA_ACCESS_READ_WRITE",
            ],
        },
    ],
    limits: [{
        name: "atlas.project.deployment.clusters",
        value: 26,
    }],
});
const testGetProjects = mongodbatlas.getProjects({
    pageNum: 1,
    itemsPerPage: 5,
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_roles_org_id()
test_project = mongodbatlas.Project("test",
    name="project-name",
    org_id=test.org_id,
    teams=[
        {
            "team_id": "5e0fa8c99ccf641c722fe645",
            "role_names": ["GROUP_OWNER"],
        },
        {
            "team_id": "5e1dd7b4f2a30ba80a70cd4rw",
            "role_names": [
                "GROUP_READ_ONLY",
                "GROUP_DATA_ACCESS_READ_WRITE",
            ],
        },
    ],
    limits=[{
        "name": "atlas.project.deployment.clusters",
        "value": 26,
    }])
test_get_projects = mongodbatlas.get_projects(page_num=1,
    items_per_page=5)
Copy
package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := mongodbatlas.GetRolesOrgId(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewProject(ctx, "test", &mongodbatlas.ProjectArgs{
			Name:  pulumi.String("project-name"),
			OrgId: pulumi.String(test.OrgId),
			Teams: mongodbatlas.ProjectTeamArray{
				&mongodbatlas.ProjectTeamArgs{
					TeamId: pulumi.String("5e0fa8c99ccf641c722fe645"),
					RoleNames: pulumi.StringArray{
						pulumi.String("GROUP_OWNER"),
					},
				},
				&mongodbatlas.ProjectTeamArgs{
					TeamId: pulumi.String("5e1dd7b4f2a30ba80a70cd4rw"),
					RoleNames: pulumi.StringArray{
						pulumi.String("GROUP_READ_ONLY"),
						pulumi.String("GROUP_DATA_ACCESS_READ_WRITE"),
					},
				},
			},
			Limits: mongodbatlas.ProjectLimitArray{
				&mongodbatlas.ProjectLimitArgs{
					Name:  pulumi.String("atlas.project.deployment.clusters"),
					Value: pulumi.Int(26),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.LookupProjects(ctx, &mongodbatlas.LookupProjectsArgs{
			PageNum:      pulumi.IntRef(1),
			ItemsPerPage: pulumi.IntRef(5),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetRolesOrgId.Invoke();

    var testProject = new Mongodbatlas.Project("test", new()
    {
        Name = "project-name",
        OrgId = test.Apply(getRolesOrgIdResult => getRolesOrgIdResult.OrgId),
        Teams = new[]
        {
            new Mongodbatlas.Inputs.ProjectTeamArgs
            {
                TeamId = "5e0fa8c99ccf641c722fe645",
                RoleNames = new[]
                {
                    "GROUP_OWNER",
                },
            },
            new Mongodbatlas.Inputs.ProjectTeamArgs
            {
                TeamId = "5e1dd7b4f2a30ba80a70cd4rw",
                RoleNames = new[]
                {
                    "GROUP_READ_ONLY",
                    "GROUP_DATA_ACCESS_READ_WRITE",
                },
            },
        },
        Limits = new[]
        {
            new Mongodbatlas.Inputs.ProjectLimitArgs
            {
                Name = "atlas.project.deployment.clusters",
                Value = 26,
            },
        },
    });

    var testGetProjects = Mongodbatlas.GetProjects.Invoke(new()
    {
        PageNum = 1,
        ItemsPerPage = 5,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.Project;
import com.pulumi.mongodbatlas.ProjectArgs;
import com.pulumi.mongodbatlas.inputs.ProjectTeamArgs;
import com.pulumi.mongodbatlas.inputs.ProjectLimitArgs;
import com.pulumi.mongodbatlas.inputs.GetProjectsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = MongodbatlasFunctions.getRolesOrgId();

        var testProject = new Project("testProject", ProjectArgs.builder()
            .name("project-name")
            .orgId(test.applyValue(getRolesOrgIdResult -> getRolesOrgIdResult.orgId()))
            .teams(            
                ProjectTeamArgs.builder()
                    .teamId("5e0fa8c99ccf641c722fe645")
                    .roleNames("GROUP_OWNER")
                    .build(),
                ProjectTeamArgs.builder()
                    .teamId("5e1dd7b4f2a30ba80a70cd4rw")
                    .roleNames(                    
                        "GROUP_READ_ONLY",
                        "GROUP_DATA_ACCESS_READ_WRITE")
                    .build())
            .limits(ProjectLimitArgs.builder()
                .name("atlas.project.deployment.clusters")
                .value(26)
                .build())
            .build());

        final var testGetProjects = MongodbatlasFunctions.getProjects(GetProjectsArgs.builder()
            .pageNum(1)
            .itemsPerPage(5)
            .build());

    }
}
Copy
resources:
  testProject:
    type: mongodbatlas:Project
    name: test
    properties:
      name: project-name
      orgId: ${test.orgId}
      teams:
        - teamId: 5e0fa8c99ccf641c722fe645
          roleNames:
            - GROUP_OWNER
        - teamId: 5e1dd7b4f2a30ba80a70cd4rw
          roleNames:
            - GROUP_READ_ONLY
            - GROUP_DATA_ACCESS_READ_WRITE
      limits:
        - name: atlas.project.deployment.clusters
          value: 26
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getRolesOrgId
      arguments: {}
  testGetProjects:
    fn::invoke:
      function: mongodbatlas:getProjects
      arguments:
        pageNum: 1
        itemsPerPage: 5
Copy

Using getProjects

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 getProjects(args: GetProjectsArgs, opts?: InvokeOptions): Promise<GetProjectsResult>
function getProjectsOutput(args: GetProjectsOutputArgs, opts?: InvokeOptions): Output<GetProjectsResult>
Copy
def get_projects(items_per_page: Optional[int] = None,
                 page_num: Optional[int] = None,
                 opts: Optional[InvokeOptions] = None) -> GetProjectsResult
def get_projects_output(items_per_page: Optional[pulumi.Input[int]] = None,
                 page_num: Optional[pulumi.Input[int]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetProjectsResult]
Copy
func LookupProjects(ctx *Context, args *LookupProjectsArgs, opts ...InvokeOption) (*LookupProjectsResult, error)
func LookupProjectsOutput(ctx *Context, args *LookupProjectsOutputArgs, opts ...InvokeOption) LookupProjectsResultOutput
Copy

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

public static class GetProjects 
{
    public static Task<GetProjectsResult> InvokeAsync(GetProjectsArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectsResult> Invoke(GetProjectsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
public static Output<GetProjectsResult> getProjects(GetProjectsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getProjects:getProjects
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ItemsPerPage int
Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int
The page to return. Defaults to 1.
ItemsPerPage int
Number of items to return per page, up to a maximum of 500. Defaults to 100.
PageNum int
The page to return. Defaults to 1.
itemsPerPage Integer
Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Integer
The page to return. Defaults to 1.
itemsPerPage number
Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum number
The page to return. Defaults to 1.
items_per_page int
Number of items to return per page, up to a maximum of 500. Defaults to 100.
page_num int
The page to return. Defaults to 1.
itemsPerPage Number
Number of items to return per page, up to a maximum of 500. Defaults to 100.
pageNum Number
The page to return. Defaults to 1.

getProjects Result

The following output properties are available:

Id string

Deprecated: Please use each project's id attribute instead

Results List<GetProjectsResult>
TotalCount int
ItemsPerPage int
PageNum int
Id string

Deprecated: Please use each project's id attribute instead

Results []GetProjectsResult
TotalCount int
ItemsPerPage int
PageNum int
id String

Deprecated: Please use each project's id attribute instead

results List<GetProjectsResult>
totalCount Integer
itemsPerPage Integer
pageNum Integer
id string

Deprecated: Please use each project's id attribute instead

results GetProjectsResult[]
totalCount number
itemsPerPage number
pageNum number
id str

Deprecated: Please use each project's id attribute instead

results Sequence[GetProjectsResult]
total_count int
items_per_page int
page_num int
id String

Deprecated: Please use each project's id attribute instead

results List<Property Map>
totalCount Number
itemsPerPage Number
pageNum Number

Supporting Types

GetProjectsResult

ClusterCount This property is required. int
The number of Atlas clusters deployed in the project.
Created This property is required. string
The ISO-8601-formatted timestamp of when Atlas created the project.
Id This property is required. string
Autogenerated Unique ID for this data source.
IpAddresses This property is required. GetProjectsResultIpAddresses
IP addresses in a project categorized by services. See IP Addresses. WARNING: this attribute is deprecated and will be removed in version 1.21.0. Use the mongodbatlas.getProjectIpAddresses data source instead.

Deprecated: This parameter is deprecated and will be removed in version 1.21.0. Please transition to mongodbatlas.getProjectIpAddresses data source.

IsCollectDatabaseSpecificsStatisticsEnabled This property is required. bool
Flag that indicates whether to enable statistics in cluster metrics collection for the project.
IsDataExplorerEnabled This property is required. bool
Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
IsExtendedStorageSizesEnabled This property is required. bool
Flag that indicates whether to enable extended storage sizes for the specified project.
IsPerformanceAdvisorEnabled This property is required. bool
Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
IsRealtimePerformancePanelEnabled This property is required. bool
Flag that indicates whether to enable Real Time Performance Panel for the project. If enabled, you can see real time metrics from your MongoDB database.
IsSchemaAdvisorEnabled This property is required. bool
Flag that indicates whether to enable Schema Advisor for the project. If enabled, you receive customized recommendations to optimize your data model and enhance performance. Disable this setting to disable schema suggestions in the Performance Advisor and the Data Explorer.
IsSlowOperationThresholdingEnabled This property is required. bool
Flag that enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. Note: To use this attribute, the requesting API Key must have the Project Owner role, if not it will show a warning and will return false. If you are not using this field, you don't need to take any action.
Limits This property is required. List<GetProjectsResultLimit>
The limits for the specified project. See Limits.
Name This property is required. string
OrgId This property is required. string
The ID of the organization you want to create the project within.
ProjectId This property is required. string
RegionUsageRestrictions This property is required. string
If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.
Tags This property is required. Dictionary<string, string>
Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. To learn more, see Resource Tags
Teams This property is required. List<GetProjectsResultTeam>
Returns all teams to which the authenticated user has access in the project. See Teams.
ClusterCount This property is required. int
The number of Atlas clusters deployed in the project.
Created This property is required. string
The ISO-8601-formatted timestamp of when Atlas created the project.
Id This property is required. string
Autogenerated Unique ID for this data source.
IpAddresses This property is required. GetProjectsResultIpAddresses
IP addresses in a project categorized by services. See IP Addresses. WARNING: this attribute is deprecated and will be removed in version 1.21.0. Use the mongodbatlas.getProjectIpAddresses data source instead.

Deprecated: This parameter is deprecated and will be removed in version 1.21.0. Please transition to mongodbatlas.getProjectIpAddresses data source.

IsCollectDatabaseSpecificsStatisticsEnabled This property is required. bool
Flag that indicates whether to enable statistics in cluster metrics collection for the project.
IsDataExplorerEnabled This property is required. bool
Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
IsExtendedStorageSizesEnabled This property is required. bool
Flag that indicates whether to enable extended storage sizes for the specified project.
IsPerformanceAdvisorEnabled This property is required. bool
Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
IsRealtimePerformancePanelEnabled This property is required. bool
Flag that indicates whether to enable Real Time Performance Panel for the project. If enabled, you can see real time metrics from your MongoDB database.
IsSchemaAdvisorEnabled This property is required. bool
Flag that indicates whether to enable Schema Advisor for the project. If enabled, you receive customized recommendations to optimize your data model and enhance performance. Disable this setting to disable schema suggestions in the Performance Advisor and the Data Explorer.
IsSlowOperationThresholdingEnabled This property is required. bool
Flag that enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. Note: To use this attribute, the requesting API Key must have the Project Owner role, if not it will show a warning and will return false. If you are not using this field, you don't need to take any action.
Limits This property is required. []GetProjectsResultLimit
The limits for the specified project. See Limits.
Name This property is required. string
OrgId This property is required. string
The ID of the organization you want to create the project within.
ProjectId This property is required. string
RegionUsageRestrictions This property is required. string
If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.
Tags This property is required. map[string]string
Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. To learn more, see Resource Tags
Teams This property is required. []GetProjectsResultTeam
Returns all teams to which the authenticated user has access in the project. See Teams.
clusterCount This property is required. Integer
The number of Atlas clusters deployed in the project.
created This property is required. String
The ISO-8601-formatted timestamp of when Atlas created the project.
id This property is required. String
Autogenerated Unique ID for this data source.
ipAddresses This property is required. GetProjectsResultIpAddresses
IP addresses in a project categorized by services. See IP Addresses. WARNING: this attribute is deprecated and will be removed in version 1.21.0. Use the mongodbatlas.getProjectIpAddresses data source instead.

Deprecated: This parameter is deprecated and will be removed in version 1.21.0. Please transition to mongodbatlas.getProjectIpAddresses data source.

isCollectDatabaseSpecificsStatisticsEnabled This property is required. Boolean
Flag that indicates whether to enable statistics in cluster metrics collection for the project.
isDataExplorerEnabled This property is required. Boolean
Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
isExtendedStorageSizesEnabled This property is required. Boolean
Flag that indicates whether to enable extended storage sizes for the specified project.
isPerformanceAdvisorEnabled This property is required. Boolean
Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
isRealtimePerformancePanelEnabled This property is required. Boolean
Flag that indicates whether to enable Real Time Performance Panel for the project. If enabled, you can see real time metrics from your MongoDB database.
isSchemaAdvisorEnabled This property is required. Boolean
Flag that indicates whether to enable Schema Advisor for the project. If enabled, you receive customized recommendations to optimize your data model and enhance performance. Disable this setting to disable schema suggestions in the Performance Advisor and the Data Explorer.
isSlowOperationThresholdingEnabled This property is required. Boolean
Flag that enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. Note: To use this attribute, the requesting API Key must have the Project Owner role, if not it will show a warning and will return false. If you are not using this field, you don't need to take any action.
limits This property is required. List<GetProjectsResultLimit>
The limits for the specified project. See Limits.
name This property is required. String
orgId This property is required. String
The ID of the organization you want to create the project within.
projectId This property is required. String
regionUsageRestrictions This property is required. String
If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.
tags This property is required. Map<String,String>
Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. To learn more, see Resource Tags
teams This property is required. List<GetProjectsResultTeam>
Returns all teams to which the authenticated user has access in the project. See Teams.
clusterCount This property is required. number
The number of Atlas clusters deployed in the project.
created This property is required. string
The ISO-8601-formatted timestamp of when Atlas created the project.
id This property is required. string
Autogenerated Unique ID for this data source.
ipAddresses This property is required. GetProjectsResultIpAddresses
IP addresses in a project categorized by services. See IP Addresses. WARNING: this attribute is deprecated and will be removed in version 1.21.0. Use the mongodbatlas.getProjectIpAddresses data source instead.

Deprecated: This parameter is deprecated and will be removed in version 1.21.0. Please transition to mongodbatlas.getProjectIpAddresses data source.

isCollectDatabaseSpecificsStatisticsEnabled This property is required. boolean
Flag that indicates whether to enable statistics in cluster metrics collection for the project.
isDataExplorerEnabled This property is required. boolean
Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
isExtendedStorageSizesEnabled This property is required. boolean
Flag that indicates whether to enable extended storage sizes for the specified project.
isPerformanceAdvisorEnabled This property is required. boolean
Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
isRealtimePerformancePanelEnabled This property is required. boolean
Flag that indicates whether to enable Real Time Performance Panel for the project. If enabled, you can see real time metrics from your MongoDB database.
isSchemaAdvisorEnabled This property is required. boolean
Flag that indicates whether to enable Schema Advisor for the project. If enabled, you receive customized recommendations to optimize your data model and enhance performance. Disable this setting to disable schema suggestions in the Performance Advisor and the Data Explorer.
isSlowOperationThresholdingEnabled This property is required. boolean
Flag that enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. Note: To use this attribute, the requesting API Key must have the Project Owner role, if not it will show a warning and will return false. If you are not using this field, you don't need to take any action.
limits This property is required. GetProjectsResultLimit[]
The limits for the specified project. See Limits.
name This property is required. string
orgId This property is required. string
The ID of the organization you want to create the project within.
projectId This property is required. string
regionUsageRestrictions This property is required. string
If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.
tags This property is required. {[key: string]: string}
Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. To learn more, see Resource Tags
teams This property is required. GetProjectsResultTeam[]
Returns all teams to which the authenticated user has access in the project. See Teams.
cluster_count This property is required. int
The number of Atlas clusters deployed in the project.
created This property is required. str
The ISO-8601-formatted timestamp of when Atlas created the project.
id This property is required. str
Autogenerated Unique ID for this data source.
ip_addresses This property is required. GetProjectsResultIpAddresses
IP addresses in a project categorized by services. See IP Addresses. WARNING: this attribute is deprecated and will be removed in version 1.21.0. Use the mongodbatlas.getProjectIpAddresses data source instead.

Deprecated: This parameter is deprecated and will be removed in version 1.21.0. Please transition to mongodbatlas.getProjectIpAddresses data source.

is_collect_database_specifics_statistics_enabled This property is required. bool
Flag that indicates whether to enable statistics in cluster metrics collection for the project.
is_data_explorer_enabled This property is required. bool
Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
is_extended_storage_sizes_enabled This property is required. bool
Flag that indicates whether to enable extended storage sizes for the specified project.
is_performance_advisor_enabled This property is required. bool
Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
is_realtime_performance_panel_enabled This property is required. bool
Flag that indicates whether to enable Real Time Performance Panel for the project. If enabled, you can see real time metrics from your MongoDB database.
is_schema_advisor_enabled This property is required. bool
Flag that indicates whether to enable Schema Advisor for the project. If enabled, you receive customized recommendations to optimize your data model and enhance performance. Disable this setting to disable schema suggestions in the Performance Advisor and the Data Explorer.
is_slow_operation_thresholding_enabled This property is required. bool
Flag that enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. Note: To use this attribute, the requesting API Key must have the Project Owner role, if not it will show a warning and will return false. If you are not using this field, you don't need to take any action.
limits This property is required. Sequence[GetProjectsResultLimit]
The limits for the specified project. See Limits.
name This property is required. str
org_id This property is required. str
The ID of the organization you want to create the project within.
project_id This property is required. str
region_usage_restrictions This property is required. str
If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.
tags This property is required. Mapping[str, str]
Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. To learn more, see Resource Tags
teams This property is required. Sequence[GetProjectsResultTeam]
Returns all teams to which the authenticated user has access in the project. See Teams.
clusterCount This property is required. Number
The number of Atlas clusters deployed in the project.
created This property is required. String
The ISO-8601-formatted timestamp of when Atlas created the project.
id This property is required. String
Autogenerated Unique ID for this data source.
ipAddresses This property is required. Property Map
IP addresses in a project categorized by services. See IP Addresses. WARNING: this attribute is deprecated and will be removed in version 1.21.0. Use the mongodbatlas.getProjectIpAddresses data source instead.

Deprecated: This parameter is deprecated and will be removed in version 1.21.0. Please transition to mongodbatlas.getProjectIpAddresses data source.

isCollectDatabaseSpecificsStatisticsEnabled This property is required. Boolean
Flag that indicates whether to enable statistics in cluster metrics collection for the project.
isDataExplorerEnabled This property is required. Boolean
Flag that indicates whether to enable Data Explorer for the project. If enabled, you can query your database with an easy to use interface.
isExtendedStorageSizesEnabled This property is required. Boolean
Flag that indicates whether to enable extended storage sizes for the specified project.
isPerformanceAdvisorEnabled This property is required. Boolean
Flag that indicates whether to enable Performance Advisor and Profiler for the project. If enabled, you can analyze database logs to recommend performance improvements.
isRealtimePerformancePanelEnabled This property is required. Boolean
Flag that indicates whether to enable Real Time Performance Panel for the project. If enabled, you can see real time metrics from your MongoDB database.
isSchemaAdvisorEnabled This property is required. Boolean
Flag that indicates whether to enable Schema Advisor for the project. If enabled, you receive customized recommendations to optimize your data model and enhance performance. Disable this setting to disable schema suggestions in the Performance Advisor and the Data Explorer.
isSlowOperationThresholdingEnabled This property is required. Boolean
Flag that enables MongoDB Cloud to use its slow operation threshold for the specified project. The threshold determines which operations the Performance Advisor and Query Profiler considers slow. When enabled, MongoDB Cloud uses the average execution time for operations on your cluster to determine slow-running queries. As a result, the threshold is more pertinent to your cluster workload. The slow operation threshold is enabled by default for dedicated clusters (M10+). When disabled, MongoDB Cloud considers any operation that takes longer than 100 milliseconds to be slow. Note: To use this attribute, the requesting API Key must have the Project Owner role, if not it will show a warning and will return false. If you are not using this field, you don't need to take any action.
limits This property is required. List<Property Map>
The limits for the specified project. See Limits.
name This property is required. String
orgId This property is required. String
The ID of the organization you want to create the project within.
projectId This property is required. String
regionUsageRestrictions This property is required. String
If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.
tags This property is required. Map<String>
Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. To learn more, see Resource Tags
teams This property is required. List<Property Map>
Returns all teams to which the authenticated user has access in the project. See Teams.

GetProjectsResultIpAddresses

services This property is required. Property Map

GetProjectsResultIpAddressesServices

clusters This property is required. List<Property Map>

GetProjectsResultIpAddressesServicesCluster

ClusterName This property is required. string
Inbounds This property is required. List<string>
Outbounds This property is required. List<string>
ClusterName This property is required. string
Inbounds This property is required. []string
Outbounds This property is required. []string
clusterName This property is required. String
inbounds This property is required. List<String>
outbounds This property is required. List<String>
clusterName This property is required. string
inbounds This property is required. string[]
outbounds This property is required. string[]
cluster_name This property is required. str
inbounds This property is required. Sequence[str]
outbounds This property is required. Sequence[str]
clusterName This property is required. String
inbounds This property is required. List<String>
outbounds This property is required. List<String>

GetProjectsResultLimit

CurrentUsage This property is required. int
Amount that indicates the current usage of the limit.
DefaultLimit This property is required. int
Default value of the limit.
MaximumLimit This property is required. int
Maximum value of the limit.
Name This property is required. string
Human-readable label that identifies this project limit.
Value This property is required. int
Amount the limit is set to.
CurrentUsage This property is required. int
Amount that indicates the current usage of the limit.
DefaultLimit This property is required. int
Default value of the limit.
MaximumLimit This property is required. int
Maximum value of the limit.
Name This property is required. string
Human-readable label that identifies this project limit.
Value This property is required. int
Amount the limit is set to.
currentUsage This property is required. Integer
Amount that indicates the current usage of the limit.
defaultLimit This property is required. Integer
Default value of the limit.
maximumLimit This property is required. Integer
Maximum value of the limit.
name This property is required. String
Human-readable label that identifies this project limit.
value This property is required. Integer
Amount the limit is set to.
currentUsage This property is required. number
Amount that indicates the current usage of the limit.
defaultLimit This property is required. number
Default value of the limit.
maximumLimit This property is required. number
Maximum value of the limit.
name This property is required. string
Human-readable label that identifies this project limit.
value This property is required. number
Amount the limit is set to.
current_usage This property is required. int
Amount that indicates the current usage of the limit.
default_limit This property is required. int
Default value of the limit.
maximum_limit This property is required. int
Maximum value of the limit.
name This property is required. str
Human-readable label that identifies this project limit.
value This property is required. int
Amount the limit is set to.
currentUsage This property is required. Number
Amount that indicates the current usage of the limit.
defaultLimit This property is required. Number
Default value of the limit.
maximumLimit This property is required. Number
Maximum value of the limit.
name This property is required. String
Human-readable label that identifies this project limit.
value This property is required. Number
Amount the limit is set to.

GetProjectsResultTeam

RoleNames This property is required. List<string>
Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
TeamId This property is required. string
The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
RoleNames This property is required. []string
Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
TeamId This property is required. string
The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
roleNames This property is required. List<String>
Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
teamId This property is required. String
The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
roleNames This property is required. string[]
Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
teamId This property is required. string
The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
role_names This property is required. Sequence[str]
Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
team_id This property is required. str
The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
roleNames This property is required. List<String>
Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
teamId This property is required. String
The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.

Package Details

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