Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. Project
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.Project

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.Project provides a Project resource. This allows project to be created.

    NOTE: If Backup Compliance Policy is enabled for the project for which this backup schedule is defined, you cannot delete the Atlas project if any snapshots exist. See Backup Compliance Policy Prohibited Actions and Considerations.

    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),
    projectOwnerId: "<OWNER_ACCOUNT_ID>",
    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,
        },
        {
            name: "atlas.project.deployment.nodesPerPrivateLinkRegion",
            value: 51,
        },
    ],
    isCollectDatabaseSpecificsStatisticsEnabled: true,
    isDataExplorerEnabled: true,
    isExtendedStorageSizesEnabled: true,
    isPerformanceAdvisorEnabled: true,
    isRealtimePerformancePanelEnabled: true,
    isSchemaAdvisorEnabled: true,
});

    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,
    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",
            ],
        ),
    ],
    limits=[
        mongodbatlas.ProjectLimitArgs(
            name="atlas.project.deployment.clusters",
            value=26,
        ),
        mongodbatlas.ProjectLimitArgs(
            name="atlas.project.deployment.nodesPerPrivateLinkRegion",
            value=51,
        ),
    ],
    is_collect_database_specifics_statistics_enabled=True,
    is_data_explorer_enabled=True,
    is_extended_storage_sizes_enabled=True,
    is_performance_advisor_enabled=True,
    is_realtime_performance_panel_enabled=True,
    is_schema_advisor_enabled=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 {
		test, err := mongodbatlas.GetRolesOrgId(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewProject(ctx, "test", &mongodbatlas.ProjectArgs{
			Name:           pulumi.String("project-name"),
			OrgId:          pulumi.String(test.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"),
					},
				},
			},
			Limits: mongodbatlas.ProjectLimitArray{
				&mongodbatlas.ProjectLimitArgs{
					Name:  pulumi.String("atlas.project.deployment.clusters"),
					Value: pulumi.Int(26),
				},
				&mongodbatlas.ProjectLimitArgs{
					Name:  pulumi.String("atlas.project.deployment.nodesPerPrivateLinkRegion"),
					Value: pulumi.Int(51),
				},
			},
			IsCollectDatabaseSpecificsStatisticsEnabled: pulumi.Bool(true),
			IsDataExplorerEnabled:                       pulumi.Bool(true),
			IsExtendedStorageSizesEnabled:               pulumi.Bool(true),
			IsPerformanceAdvisorEnabled:                 pulumi.Bool(true),
			IsRealtimePerformancePanelEnabled:           pulumi.Bool(true),
			IsSchemaAdvisorEnabled:                      pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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),
        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",
                },
            },
        },
        Limits = new[]
        {
            new Mongodbatlas.Inputs.ProjectLimitArgs
            {
                Name = "atlas.project.deployment.clusters",
                Value = 26,
            },
            new Mongodbatlas.Inputs.ProjectLimitArgs
            {
                Name = "atlas.project.deployment.nodesPerPrivateLinkRegion",
                Value = 51,
            },
        },
        IsCollectDatabaseSpecificsStatisticsEnabled = true,
        IsDataExplorerEnabled = true,
        IsExtendedStorageSizesEnabled = true,
        IsPerformanceAdvisorEnabled = true,
        IsRealtimePerformancePanelEnabled = true,
        IsSchemaAdvisorEnabled = true,
    });

});

    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 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()))
            .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())
            .limits(            
                ProjectLimitArgs.builder()
                    .name("atlas.project.deployment.clusters")
                    .value(26)
                    .build(),
                ProjectLimitArgs.builder()
                    .name("atlas.project.deployment.nodesPerPrivateLinkRegion")
                    .value(51)
                    .build())
            .isCollectDatabaseSpecificsStatisticsEnabled(true)
            .isDataExplorerEnabled(true)
            .isExtendedStorageSizesEnabled(true)
            .isPerformanceAdvisorEnabled(true)
            .isRealtimePerformancePanelEnabled(true)
            .isSchemaAdvisorEnabled(true)
            .build());

    }
}

    resources:
  testProject:
    type: mongodbatlas:Project
    name: test
    properties:
      name: project-name
      orgId: ${test.orgId}
      projectOwnerId: <OWNER_ACCOUNT_ID>
      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
        - name: atlas.project.deployment.nodesPerPrivateLinkRegion
          value: 51
      isCollectDatabaseSpecificsStatisticsEnabled: true
      isDataExplorerEnabled: true
      isExtendedStorageSizesEnabled: true
      isPerformanceAdvisorEnabled: true
      isRealtimePerformancePanelEnabled: true
      isSchemaAdvisorEnabled: true
variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getRolesOrgId
      Arguments: {}

    Create Project Resource

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

    Constructor syntax

    new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
    @overload
def Project(resource_name: str,
            args: ProjectArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Project(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            org_id: Optional[str] = None,
            limits: Optional[Sequence[ProjectLimitArgs]] = None,
            is_extended_storage_sizes_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,
            is_collect_database_specifics_statistics_enabled: Optional[bool] = None,
            name: Optional[str] = None,
            is_data_explorer_enabled: Optional[bool] = None,
            project_owner_id: Optional[str] = None,
            region_usage_restrictions: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            teams: Optional[Sequence[ProjectTeamArgs]] = None,
            with_default_alerts_settings: Optional[bool] = 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.

    Parameters

    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.

    Constructor example

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

    var projectResource = new Mongodbatlas.Project("projectResource", new()
{
    OrgId = "string",
    Limits = new[]
    {
        new Mongodbatlas.Inputs.ProjectLimitArgs
        {
            Name = "string",
            Value = 0,
            CurrentUsage = 0,
            DefaultLimit = 0,
            MaximumLimit = 0,
        },
    },
    IsExtendedStorageSizesEnabled = false,
    IsPerformanceAdvisorEnabled = false,
    IsRealtimePerformancePanelEnabled = false,
    IsSchemaAdvisorEnabled = false,
    IsCollectDatabaseSpecificsStatisticsEnabled = false,
    Name = "string",
    IsDataExplorerEnabled = false,
    ProjectOwnerId = "string",
    RegionUsageRestrictions = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Teams = new[]
    {
        new Mongodbatlas.Inputs.ProjectTeamArgs
        {
            RoleNames = new[]
            {
                "string",
            },
            TeamId = "string",
        },
    },
    WithDefaultAlertsSettings = false,
});

    example, err := mongodbatlas.NewProject(ctx, "projectResource", &mongodbatlas.ProjectArgs{
	OrgId: pulumi.String("string"),
	Limits: mongodbatlas.ProjectLimitArray{
		&mongodbatlas.ProjectLimitArgs{
			Name:         pulumi.String("string"),
			Value:        pulumi.Int(0),
			CurrentUsage: pulumi.Int(0),
			DefaultLimit: pulumi.Int(0),
			MaximumLimit: pulumi.Int(0),
		},
	},
	IsExtendedStorageSizesEnabled:               pulumi.Bool(false),
	IsPerformanceAdvisorEnabled:                 pulumi.Bool(false),
	IsRealtimePerformancePanelEnabled:           pulumi.Bool(false),
	IsSchemaAdvisorEnabled:                      pulumi.Bool(false),
	IsCollectDatabaseSpecificsStatisticsEnabled: pulumi.Bool(false),
	Name:                    pulumi.String("string"),
	IsDataExplorerEnabled:   pulumi.Bool(false),
	ProjectOwnerId:          pulumi.String("string"),
	RegionUsageRestrictions: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Teams: mongodbatlas.ProjectTeamArray{
		&mongodbatlas.ProjectTeamArgs{
			RoleNames: pulumi.StringArray{
				pulumi.String("string"),
			},
			TeamId: pulumi.String("string"),
		},
	},
	WithDefaultAlertsSettings: pulumi.Bool(false),
})

    var projectResource = new Project("projectResource", ProjectArgs.builder()
    .orgId("string")
    .limits(ProjectLimitArgs.builder()
        .name("string")
        .value(0)
        .currentUsage(0)
        .defaultLimit(0)
        .maximumLimit(0)
        .build())
    .isExtendedStorageSizesEnabled(false)
    .isPerformanceAdvisorEnabled(false)
    .isRealtimePerformancePanelEnabled(false)
    .isSchemaAdvisorEnabled(false)
    .isCollectDatabaseSpecificsStatisticsEnabled(false)
    .name("string")
    .isDataExplorerEnabled(false)
    .projectOwnerId("string")
    .regionUsageRestrictions("string")
    .tags(Map.of("string", "string"))
    .teams(ProjectTeamArgs.builder()
        .roleNames("string")
        .teamId("string")
        .build())
    .withDefaultAlertsSettings(false)
    .build());

    project_resource = mongodbatlas.Project("projectResource",
    org_id="string",
    limits=[mongodbatlas.ProjectLimitArgs(
        name="string",
        value=0,
        current_usage=0,
        default_limit=0,
        maximum_limit=0,
    )],
    is_extended_storage_sizes_enabled=False,
    is_performance_advisor_enabled=False,
    is_realtime_performance_panel_enabled=False,
    is_schema_advisor_enabled=False,
    is_collect_database_specifics_statistics_enabled=False,
    name="string",
    is_data_explorer_enabled=False,
    project_owner_id="string",
    region_usage_restrictions="string",
    tags={
        "string": "string",
    },
    teams=[mongodbatlas.ProjectTeamArgs(
        role_names=["string"],
        team_id="string",
    )],
    with_default_alerts_settings=False)

    const projectResource = new mongodbatlas.Project("projectResource", {
    orgId: "string",
    limits: [{
        name: "string",
        value: 0,
        currentUsage: 0,
        defaultLimit: 0,
        maximumLimit: 0,
    }],
    isExtendedStorageSizesEnabled: false,
    isPerformanceAdvisorEnabled: false,
    isRealtimePerformancePanelEnabled: false,
    isSchemaAdvisorEnabled: false,
    isCollectDatabaseSpecificsStatisticsEnabled: false,
    name: "string",
    isDataExplorerEnabled: false,
    projectOwnerId: "string",
    regionUsageRestrictions: "string",
    tags: {
        string: "string",
    },
    teams: [{
        roleNames: ["string"],
        teamId: "string",
    }],
    withDefaultAlertsSettings: false,
});

    type: mongodbatlas:Project
properties:
    isCollectDatabaseSpecificsStatisticsEnabled: false
    isDataExplorerEnabled: false
    isExtendedStorageSizesEnabled: false
    isPerformanceAdvisorEnabled: false
    isRealtimePerformancePanelEnabled: false
    isSchemaAdvisorEnabled: false
    limits:
        - currentUsage: 0
          defaultLimit: 0
          maximumLimit: 0
          name: string
          value: 0
    name: string
    orgId: string
    projectOwnerId: string
    regionUsageRestrictions: string
    tags:
        string: string
    teams:
        - roleNames:
            - string
          teamId: string
    withDefaultAlertsSettings: false

    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.
    IsCollectDatabaseSpecificsStatisticsEnabled bool
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    IsExtendedStorageSizesEnabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    Limits List<ProjectLimit>
    Name string
    The name of the project you want to create.
    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.
    Tags Dictionary<string, string>
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    Teams List<ProjectTeam>
    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.
    IsCollectDatabaseSpecificsStatisticsEnabled bool
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    IsExtendedStorageSizesEnabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    Limits []ProjectLimitArgs
    Name string
    The name of the project you want to create.
    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.
    Tags map[string]string
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    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.
    isCollectDatabaseSpecificsStatisticsEnabled Boolean
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    isExtendedStorageSizesEnabled Boolean
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits List<ProjectLimit>
    name String
    The name of the project you want to create.
    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.
    tags Map<String,String>
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    teams List<ProjectTeam>
    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.
    isCollectDatabaseSpecificsStatisticsEnabled boolean
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    isExtendedStorageSizesEnabled boolean
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits ProjectLimit[]
    name string
    The name of the project you want to create.
    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.
    tags {[key: string]: string}
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    teams ProjectTeam[]
    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.
    is_collect_database_specifics_statistics_enabled bool
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    is_extended_storage_sizes_enabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits Sequence[ProjectLimitArgs]
    name str
    The name of the project you want to create.
    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.
    tags Mapping[str, str]
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    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.
    isCollectDatabaseSpecificsStatisticsEnabled Boolean
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    isExtendedStorageSizesEnabled Boolean
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits List<Property Map>
    name String
    The name of the project you want to create.
    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.
    tags Map<String>
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    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.
    IpAddresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    IpAddresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    ipAddresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    ipAddresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    ip_addresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    ipAddresses Property Map
    IP addresses in a project categorized by services. See IP Addresses.

    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,
        cluster_count: Optional[int] = None,
        created: Optional[str] = None,
        ip_addresses: Optional[ProjectIpAddressesArgs] = None,
        is_collect_database_specifics_statistics_enabled: Optional[bool] = None,
        is_data_explorer_enabled: Optional[bool] = None,
        is_extended_storage_sizes_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,
        limits: Optional[Sequence[ProjectLimitArgs]] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_owner_id: Optional[str] = None,
        region_usage_restrictions: Optional[str] = None,
        tags: Optional[Mapping[str, 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:
    ClusterCount int
    The number of Atlas clusters deployed in the project.
    Created string
    The ISO-8601-formatted timestamp of when Atlas created the project.
    IpAddresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    IsCollectDatabaseSpecificsStatisticsEnabled bool
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    IsExtendedStorageSizesEnabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    Limits List<ProjectLimit>
    Name string
    The name of the project you want to create.
    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.
    Tags Dictionary<string, string>
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    Teams List<ProjectTeam>
    WithDefaultAlertsSettings bool
    It allows users to disable the creation of the default alert settings. By default, this flag is set to true.
    ClusterCount int
    The number of Atlas clusters deployed in the project.
    Created string
    The ISO-8601-formatted timestamp of when Atlas created the project.
    IpAddresses ProjectIpAddressesArgs
    IP addresses in a project categorized by services. See IP Addresses.
    IsCollectDatabaseSpecificsStatisticsEnabled bool
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    IsExtendedStorageSizesEnabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    Limits []ProjectLimitArgs
    Name string
    The name of the project you want to create.
    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.
    Tags map[string]string
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    Teams []ProjectTeamArgs
    WithDefaultAlertsSettings bool
    It allows users to disable the creation of the default alert settings. By default, this flag is set to true.
    clusterCount Integer
    The number of Atlas clusters deployed in the project.
    created String
    The ISO-8601-formatted timestamp of when Atlas created the project.
    ipAddresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    isCollectDatabaseSpecificsStatisticsEnabled Boolean
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    isExtendedStorageSizesEnabled Boolean
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits List<ProjectLimit>
    name String
    The name of the project you want to create.
    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.
    tags Map<String,String>
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    teams List<ProjectTeam>
    withDefaultAlertsSettings Boolean
    It allows users to disable the creation of the default alert settings. By default, this flag is set to true.
    clusterCount number
    The number of Atlas clusters deployed in the project.
    created string
    The ISO-8601-formatted timestamp of when Atlas created the project.
    ipAddresses ProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    isCollectDatabaseSpecificsStatisticsEnabled boolean
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    isExtendedStorageSizesEnabled boolean
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits ProjectLimit[]
    name string
    The name of the project you want to create.
    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.
    tags {[key: string]: string}
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    teams ProjectTeam[]
    withDefaultAlertsSettings boolean
    It allows users to disable the creation of the default alert settings. By default, this flag is set to true.
    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.
    ip_addresses ProjectIpAddressesArgs
    IP addresses in a project categorized by services. See IP Addresses.
    is_collect_database_specifics_statistics_enabled bool
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    is_extended_storage_sizes_enabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits Sequence[ProjectLimitArgs]
    name str
    The name of the project you want to create.
    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.
    tags Mapping[str, str]
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    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.
    clusterCount Number
    The number of Atlas clusters deployed in the project.
    created String
    The ISO-8601-formatted timestamp of when Atlas created the project.
    ipAddresses Property Map
    IP addresses in a project categorized by services. See IP Addresses.
    isCollectDatabaseSpecificsStatisticsEnabled Boolean
    Flag that indicates whether to enable statistics in cluster metrics collection for the project. By default, this flag is set to true.
    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. By default, this flag is set to true.
    isExtendedStorageSizesEnabled Boolean
    Flag that indicates whether to enable extended storage sizes for the specified project. Clusters with extended storage sizes must be on AWS or GCP, and cannot span multiple regions. When extending storage size, initial syncs and cross-project snapshot restores will be slow. This setting should only be used as a measure of temporary relief; consider sharding if more storage is required.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    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. By default, this flag is set to true.
    limits List<Property Map>
    name String
    The name of the project you want to create.
    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.
    tags Map<String>
    Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project. See below.
    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

    ProjectIpAddresses, ProjectIpAddressesArgs

    ProjectIpAddressesServices, ProjectIpAddressesServicesArgs

    ProjectIpAddressesServicesCluster, ProjectIpAddressesServicesClusterArgs

    ClusterName string
    Inbounds List<string>
    Outbounds List<string>
    ClusterName string
    Inbounds []string
    Outbounds []string
    clusterName String
    inbounds List<String>
    outbounds List<String>
    clusterName string
    inbounds string[]
    outbounds string[]
    cluster_name str
    inbounds Sequence[str]
    outbounds Sequence[str]
    clusterName String
    inbounds List<String>
    outbounds List<String>

    ProjectLimit, ProjectLimitArgs

    Name string
    Human-readable label that identifies this project limit. See Project Limit Documentation under limitName parameter to find all the limits that can be defined.
    Value int
    Amount to set the limit to. Use the Project Limit Documentation under limitName parameter to verify the override limits.
    CurrentUsage int
    DefaultLimit int
    MaximumLimit int
    Name string
    Human-readable label that identifies this project limit. See Project Limit Documentation under limitName parameter to find all the limits that can be defined.
    Value int
    Amount to set the limit to. Use the Project Limit Documentation under limitName parameter to verify the override limits.
    CurrentUsage int
    DefaultLimit int
    MaximumLimit int
    name String
    Human-readable label that identifies this project limit. See Project Limit Documentation under limitName parameter to find all the limits that can be defined.
    value Integer
    Amount to set the limit to. Use the Project Limit Documentation under limitName parameter to verify the override limits.
    currentUsage Integer
    defaultLimit Integer
    maximumLimit Integer
    name string
    Human-readable label that identifies this project limit. See Project Limit Documentation under limitName parameter to find all the limits that can be defined.
    value number
    Amount to set the limit to. Use the Project Limit Documentation under limitName parameter to verify the override limits.
    currentUsage number
    defaultLimit number
    maximumLimit number
    name str
    Human-readable label that identifies this project limit. See Project Limit Documentation under limitName parameter to find all the limits that can be defined.
    value int
    Amount to set the limit to. Use the Project Limit Documentation under limitName parameter to verify the override limits.
    current_usage int
    default_limit int
    maximum_limit int
    name String
    Human-readable label that identifies this project limit. See Project Limit Documentation under limitName parameter to find all the limits that can be defined.
    value Number
    Amount to set the limit to. Use the Project Limit Documentation under limitName parameter to verify the override limits.
    currentUsage Number
    defaultLimit Number
    maximumLimit Number

    ProjectTeam, ProjectTeamArgs

    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 MongoDB Documentation describes the roles a user can have.

    NOTE: Project created by API Keys must belong to an existing organization.

    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 MongoDB Documentation describes the roles a user can have.

    NOTE: Project created by API Keys must belong to an existing organization.

    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 MongoDB Documentation describes the roles a user can have.

    NOTE: Project created by API Keys must belong to an existing organization.

    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 MongoDB Documentation describes the roles a user can have.

    NOTE: Project created by API Keys must belong to an existing organization.

    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 MongoDB Documentation describes the roles a user can have.

    NOTE: Project created by API Keys must belong to an existing organization.

    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 MongoDB Documentation describes the roles a user can have.

    NOTE: Project created by API Keys must belong to an existing organization.

    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.

    Import

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

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

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

    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.
    mongodbatlas logo
    MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas