Docs Packages
  1. Pulumi Registry
  2. MongoDB Atlas
  3. API Docs
  4. Project
mongodbatlas logo
MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.Project

Explore with Pulumi AI

Import

Project must be imported using project ID, e.g.

 $ pulumi import mongodbatlas:index/project:Project my_project 5d09d6a59ccf6445652a444a

For more information seeMongoDB Atlas Admin API Projects and MongoDB Atlas Admin API Teams Documentation for more information.

Example Usage

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

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

    var testProject = new Mongodbatlas.Project("testProject", new()
    {
        OrgId = testRolesOrgId.Apply(getRolesOrgIdResult => getRolesOrgIdResult.OrgId),
        ProjectOwnerId = "<OWNER_ACCOUNT_ID>",
        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",
                },
            },
        },
        ApiKeys = new[]
        {
            new Mongodbatlas.Inputs.ProjectApiKeyArgs
            {
                ApiKeyId = "61003b299dda8d54a9d7d10c",
                RoleNames = new[]
                {
                    "GROUP_READ_ONLY",
                },
            },
        },
        IsCollectDatabaseSpecificsStatisticsEnabled = true,
        IsDataExplorerEnabled = true,
        IsPerformanceAdvisorEnabled = true,
        IsRealtimePerformancePanelEnabled = true,
        IsSchemaAdvisorEnabled = true,
    });

});

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 {
		testRolesOrgId, err := mongodbatlas.GetRolesOrgId(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewProject(ctx, "testProject", &mongodbatlas.ProjectArgs{
			OrgId:          *pulumi.String(testRolesOrgId.OrgId),
			ProjectOwnerId: pulumi.String("<OWNER_ACCOUNT_ID>"),
			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"),
					},
				},
			},
			ApiKeys: mongodbatlas.ProjectApiKeyTypeArray{
				&mongodbatlas.ProjectApiKeyTypeArgs{
					ApiKeyId: pulumi.String("61003b299dda8d54a9d7d10c"),
					RoleNames: pulumi.StringArray{
						pulumi.String("GROUP_READ_ONLY"),
					},
				},
			},
			IsCollectDatabaseSpecificsStatisticsEnabled: pulumi.Bool(true),
			IsDataExplorerEnabled:                       pulumi.Bool(true),
			IsPerformanceAdvisorEnabled:                 pulumi.Bool(true),
			IsRealtimePerformancePanelEnabled:           pulumi.Bool(true),
			IsSchemaAdvisorEnabled:                      pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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.ProjectApiKeyArgs;
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 testRolesOrgId = MongodbatlasFunctions.getRolesOrgId();

        var testProject = new Project("testProject", ProjectArgs.builder()        
            .orgId(testRolesOrgId.applyValue(getRolesOrgIdResult -> getRolesOrgIdResult.orgId()))
            .projectOwnerId("<OWNER_ACCOUNT_ID>")
            .teams(            
                ProjectTeamArgs.builder()
                    .teamId("5e0fa8c99ccf641c722fe645")
                    .roleNames("GROUP_OWNER")
                    .build(),
                ProjectTeamArgs.builder()
                    .teamId("5e1dd7b4f2a30ba80a70cd4rw")
                    .roleNames(                    
                        "GROUP_READ_ONLY",
                        "GROUP_DATA_ACCESS_READ_WRITE")
                    .build())
            .apiKeys(ProjectApiKeyArgs.builder()
                .apiKeyId("61003b299dda8d54a9d7d10c")
                .roleNames("GROUP_READ_ONLY")
                .build())
            .isCollectDatabaseSpecificsStatisticsEnabled(true)
            .isDataExplorerEnabled(true)
            .isPerformanceAdvisorEnabled(true)
            .isRealtimePerformancePanelEnabled(true)
            .isSchemaAdvisorEnabled(true)
            .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_roles_org_id = mongodbatlas.get_roles_org_id()
test_project = mongodbatlas.Project("testProject",
    org_id=test_roles_org_id.org_id,
    project_owner_id="<OWNER_ACCOUNT_ID>",
    teams=[
        mongodbatlas.ProjectTeamArgs(
            team_id="5e0fa8c99ccf641c722fe645",
            role_names=["GROUP_OWNER"],
        ),
        mongodbatlas.ProjectTeamArgs(
            team_id="5e1dd7b4f2a30ba80a70cd4rw",
            role_names=[
                "GROUP_READ_ONLY",
                "GROUP_DATA_ACCESS_READ_WRITE",
            ],
        ),
    ],
    api_keys=[mongodbatlas.ProjectApiKeyArgs(
        api_key_id="61003b299dda8d54a9d7d10c",
        role_names=["GROUP_READ_ONLY"],
    )],
    is_collect_database_specifics_statistics_enabled=True,
    is_data_explorer_enabled=True,
    is_performance_advisor_enabled=True,
    is_realtime_performance_panel_enabled=True,
    is_schema_advisor_enabled=True)

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

const testRolesOrgId = mongodbatlas.getRolesOrgId({});
const testProject = new mongodbatlas.Project("testProject", {
    orgId: testRolesOrgId.then(testRolesOrgId => testRolesOrgId.orgId),
    projectOwnerId: "<OWNER_ACCOUNT_ID>",
    teams: [
        {
            teamId: "5e0fa8c99ccf641c722fe645",
            roleNames: ["GROUP_OWNER"],
        },
        {
            teamId: "5e1dd7b4f2a30ba80a70cd4rw",
            roleNames: [
                "GROUP_READ_ONLY",
                "GROUP_DATA_ACCESS_READ_WRITE",
            ],
        },
    ],
    apiKeys: [{
        apiKeyId: "61003b299dda8d54a9d7d10c",
        roleNames: ["GROUP_READ_ONLY"],
    }],
    isCollectDatabaseSpecificsStatisticsEnabled: true,
    isDataExplorerEnabled: true,
    isPerformanceAdvisorEnabled: true,
    isRealtimePerformancePanelEnabled: true,
    isSchemaAdvisorEnabled: true,
});

resources:
  testProject:
    type: mongodbatlas:Project
    properties:
      orgId: ${testRolesOrgId.orgId}
      projectOwnerId: <OWNER_ACCOUNT_ID>
      teams:
        - teamId: 5e0fa8c99ccf641c722fe645
          roleNames:
            - GROUP_OWNER
        - teamId: 5e1dd7b4f2a30ba80a70cd4rw
          roleNames:
            - GROUP_READ_ONLY
            - GROUP_DATA_ACCESS_READ_WRITE
      apiKeys:
        - apiKeyId: 61003b299dda8d54a9d7d10c
          roleNames:
            - GROUP_READ_ONLY
      isCollectDatabaseSpecificsStatisticsEnabled: true
      isDataExplorerEnabled: true
      isPerformanceAdvisorEnabled: true
      isRealtimePerformancePanelEnabled: true
      isSchemaAdvisorEnabled: true
variables:
  testRolesOrgId:
    fn::invoke:
      Function: mongodbatlas:getRolesOrgId
      Arguments: {}

Create Project Resource

new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
@overload
def Project(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            api_keys: Optional[Sequence[ProjectApiKeyArgs]] = None,
            is_collect_database_specifics_statistics_enabled: Optional[bool] = None,
            is_data_explorer_enabled: Optional[bool] = None,
            is_performance_advisor_enabled: Optional[bool] = None,
            is_realtime_performance_panel_enabled: Optional[bool] = None,
            is_schema_advisor_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_owner_id: Optional[str] = None,
            region_usage_restrictions: Optional[str] = None,
            teams: Optional[Sequence[ProjectTeamArgs]] = None,
            with_default_alerts_settings: Optional[bool] = None)
@overload
def Project(resource_name: str,
            args: ProjectArgs,
            opts: Optional[ResourceOptions] = None)
func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)

type: mongodbatlas:Project
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProjectArgs
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 ProjectArgs
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 ProjectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ProjectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ProjectArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Project Resource Properties

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

Inputs

The Project resource accepts the following input properties:

OrgId string

The ID of the organization you want to create the project within.

ApiKeys List<ProjectApiKeyArgs>
IsCollectDatabaseSpecificsStatisticsEnabled bool

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

IsDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

IsPerformanceAdvisorEnabled 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 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 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.

Name string

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

ProjectOwnerId string

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

RegionUsageRestrictions string

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

Teams List<ProjectTeamArgs>
WithDefaultAlertsSettings bool

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

OrgId string

The ID of the organization you want to create the project within.

ApiKeys []ProjectApiKeyTypeArgs
IsCollectDatabaseSpecificsStatisticsEnabled bool

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

IsDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

IsPerformanceAdvisorEnabled 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 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 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.

Name string

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

ProjectOwnerId string

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

RegionUsageRestrictions string

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

Teams []ProjectTeamArgs
WithDefaultAlertsSettings bool

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

orgId String

The ID of the organization you want to create the project within.

apiKeys List<ProjectApiKeyArgs>
isCollectDatabaseSpecificsStatisticsEnabled Boolean

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

isDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

isPerformanceAdvisorEnabled 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 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 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.

name String

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

projectOwnerId String

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

regionUsageRestrictions String

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams List<ProjectTeamArgs>
withDefaultAlertsSettings Boolean

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

orgId string

The ID of the organization you want to create the project within.

apiKeys ProjectApiKeyArgs[]
isCollectDatabaseSpecificsStatisticsEnabled boolean

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

isDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

isPerformanceAdvisorEnabled 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 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 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.

name string

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

projectOwnerId string

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

regionUsageRestrictions string

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams ProjectTeamArgs[]
withDefaultAlertsSettings boolean

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

org_id str

The ID of the organization you want to create the project within.

api_keys Sequence[ProjectApiKeyArgs]
is_collect_database_specifics_statistics_enabled bool

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

is_data_explorer_enabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

is_performance_advisor_enabled 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 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 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.

name str

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

project_owner_id str

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

region_usage_restrictions str

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams Sequence[ProjectTeamArgs]
with_default_alerts_settings bool

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

orgId String

The ID of the organization you want to create the project within.

apiKeys List<Property Map>
isCollectDatabaseSpecificsStatisticsEnabled Boolean

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

isDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

isPerformanceAdvisorEnabled 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 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 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.

name String

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

projectOwnerId String

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

regionUsageRestrictions String

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams List<Property Map>
withDefaultAlertsSettings Boolean

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

Outputs

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

ClusterCount int

The number of Atlas clusters deployed in the project..

Created string

The ISO-8601-formatted timestamp of when Atlas created the project..

Id string

The provider-assigned unique ID for this managed resource.

ClusterCount int

The number of Atlas clusters deployed in the project..

Created string

The ISO-8601-formatted timestamp of when Atlas created the project..

Id string

The provider-assigned unique ID for this managed resource.

clusterCount Integer

The number of Atlas clusters deployed in the project..

created String

The ISO-8601-formatted timestamp of when Atlas created the project..

id String

The provider-assigned unique ID for this managed resource.

clusterCount number

The number of Atlas clusters deployed in the project..

created string

The ISO-8601-formatted timestamp of when Atlas created the project..

id string

The provider-assigned unique ID for this managed resource.

cluster_count int

The number of Atlas clusters deployed in the project..

created str

The ISO-8601-formatted timestamp of when Atlas created the project..

id str

The provider-assigned unique ID for this managed resource.

clusterCount Number

The number of Atlas clusters deployed in the project..

created String

The ISO-8601-formatted timestamp of when Atlas created the project..

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Project Resource

Get an existing Project 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?: ProjectState, opts?: CustomResourceOptions): Project
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_keys: Optional[Sequence[ProjectApiKeyArgs]] = None,
        cluster_count: Optional[int] = None,
        created: Optional[str] = None,
        is_collect_database_specifics_statistics_enabled: Optional[bool] = None,
        is_data_explorer_enabled: Optional[bool] = None,
        is_performance_advisor_enabled: Optional[bool] = None,
        is_realtime_performance_panel_enabled: Optional[bool] = None,
        is_schema_advisor_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_owner_id: Optional[str] = None,
        region_usage_restrictions: Optional[str] = None,
        teams: Optional[Sequence[ProjectTeamArgs]] = None,
        with_default_alerts_settings: Optional[bool] = None) -> Project
func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
ApiKeys List<ProjectApiKeyArgs>
ClusterCount int

The number of Atlas clusters deployed in the project..

Created string

The ISO-8601-formatted timestamp of when Atlas created the project..

IsCollectDatabaseSpecificsStatisticsEnabled bool

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

IsDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

IsPerformanceAdvisorEnabled 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 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 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.

Name string

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

OrgId string

The ID of the organization you want to create the project within.

ProjectOwnerId string

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

RegionUsageRestrictions string

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

Teams List<ProjectTeamArgs>
WithDefaultAlertsSettings bool

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

ApiKeys []ProjectApiKeyTypeArgs
ClusterCount int

The number of Atlas clusters deployed in the project..

Created string

The ISO-8601-formatted timestamp of when Atlas created the project..

IsCollectDatabaseSpecificsStatisticsEnabled bool

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

IsDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

IsPerformanceAdvisorEnabled 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 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 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.

Name string

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

OrgId string

The ID of the organization you want to create the project within.

ProjectOwnerId string

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

RegionUsageRestrictions string

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

Teams []ProjectTeamArgs
WithDefaultAlertsSettings bool

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

apiKeys List<ProjectApiKeyArgs>
clusterCount Integer

The number of Atlas clusters deployed in the project..

created String

The ISO-8601-formatted timestamp of when Atlas created the project..

isCollectDatabaseSpecificsStatisticsEnabled Boolean

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

isDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

isPerformanceAdvisorEnabled 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 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 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.

name String

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

orgId String

The ID of the organization you want to create the project within.

projectOwnerId String

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

regionUsageRestrictions String

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams List<ProjectTeamArgs>
withDefaultAlertsSettings Boolean

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

apiKeys ProjectApiKeyArgs[]
clusterCount number

The number of Atlas clusters deployed in the project..

created string

The ISO-8601-formatted timestamp of when Atlas created the project..

isCollectDatabaseSpecificsStatisticsEnabled boolean

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

isDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

isPerformanceAdvisorEnabled 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 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 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.

name string

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

orgId string

The ID of the organization you want to create the project within.

projectOwnerId string

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

regionUsageRestrictions string

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams ProjectTeamArgs[]
withDefaultAlertsSettings boolean

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

api_keys Sequence[ProjectApiKeyArgs]
cluster_count int

The number of Atlas clusters deployed in the project..

created str

The ISO-8601-formatted timestamp of when Atlas created the project..

is_collect_database_specifics_statistics_enabled bool

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

is_data_explorer_enabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

is_performance_advisor_enabled 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 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 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.

name str

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

org_id str

The ID of the organization you want to create the project within.

project_owner_id str

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

region_usage_restrictions str

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams Sequence[ProjectTeamArgs]
with_default_alerts_settings bool

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

apiKeys List<Property Map>
clusterCount Number

The number of Atlas clusters deployed in the project..

created String

The ISO-8601-formatted timestamp of when Atlas created the project..

isCollectDatabaseSpecificsStatisticsEnabled Boolean

Flag that indicates whether to enable statistics in cluster metrics collection for the project.

isDataExplorerEnabled 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. When Data Explorer is disabled, you cannot terminate slow operations from the Real-Time Performance Panel or create indexes from the Performance Advisor. You can still view Performance Advisor recommendations, but you must create those indexes from mongosh.

isPerformanceAdvisorEnabled 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 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 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.

name String

The name of the project you want to create. (Cannot be changed via this Provider after creation.)

orgId String

The ID of the organization you want to create the project within.

projectOwnerId String

Unique 24-hexadecimal digit string that identifies the Atlas user account to be granted the Project Owner role on the specified project. If you set this parameter, it overrides the default value of the oldest Organization Owner.

regionUsageRestrictions String

Designates that this project can be used for government regions only. If not set the project will default to standard regions. You cannot deploy clusters across government and standard regions in the same project. AWS is the only cloud provider for AtlasGov. For more information see MongoDB Atlas for Government.

teams List<Property Map>
withDefaultAlertsSettings Boolean

It allows users to disable the creation of the default alert settings. By default, this flag is set to true.

Supporting Types

ProjectApiKey

ApiKeyId string

The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the publicKey of the Programmatic API key but the id of the key. See Programmatic API Keys for more.

RoleNames List<string>

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles: The following are valid roles:

ApiKeyId string

The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the publicKey of the Programmatic API key but the id of the key. See Programmatic API Keys for more.

RoleNames []string

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles: The following are valid roles:

apiKeyId String

The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the publicKey of the Programmatic API key but the id of the key. See Programmatic API Keys for more.

roleNames List<String>

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles: The following are valid roles:

apiKeyId string

The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the publicKey of the Programmatic API key but the id of the key. See Programmatic API Keys for more.

roleNames string[]

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles: The following are valid roles:

api_key_id str

The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the publicKey of the Programmatic API key but the id of the key. See Programmatic API Keys for more.

role_names Sequence[str]

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles: The following are valid roles:

apiKeyId String

The unique identifier of the Programmatic API key you want to associate with the Project. The Programmatic API key and Project must share the same parent organization. Note: this is not the publicKey of the Programmatic API key but the id of the key. See Programmatic API Keys for more.

roleNames List<String>

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles: The following are valid roles:

ProjectTeam

RoleNames List<string>

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles:

TeamId 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 []string

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles:

TeamId 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 List<String>

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles:

teamId 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 string[]

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles:

teamId 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 Sequence[str]

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles:

team_id 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 List<String>

Each string in the array represents a project role you want to assign to the team. Every user associated with the team inherits these roles. You must specify an array even if you are only associating a single role with the team. The following are valid roles:

teamId 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.