MongoDB Atlas

Pulumi Official
Package maintained by Pulumi
v3.5.0 published on Wednesday, Jul 20, 2022 by Pulumi

getProject

mongodbatlas.Project describes a MongoDB Atlas Project. This represents a project that has been created.

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

Example Usage

Using project_id attribute to query

Coming soon!

Coming soon!

Coming soon!

Coming soon!

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

const testMongodbatlasProject = new mongodbatlas.Project("test", {
    orgId: "<ORG_ID>",
    teams: [
        {
            roleNames: ["GROUP_OWNER"],
            teamId: "5e0fa8c99ccf641c722fe645",
        },
        {
            roleNames: [
                "GROUP_READ_ONLY",
                "GROUP_DATA_ACCESS_READ_WRITE",
            ],
            teamId: "5e1dd7b4f2a30ba80a70cd4rw",
        },
    ],
});
const testProject = testMongodbatlasProject.id.apply(id => mongodbatlas.getProject({
    projectId: id,
}));

Coming soon!

Using getProject

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
def get_project(name: Optional[str] = None,
                project_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(name: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput

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

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: mongodbatlas:index/getProject:getProject
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The unique ID for the project.

ProjectId string

The unique ID for the project.

Name string

The unique ID for the project.

ProjectId string

The unique ID for the project.

name String

The unique ID for the project.

projectId String

The unique ID for the project.

name string

The unique ID for the project.

projectId string

The unique ID for the project.

name str

The unique ID for the project.

project_id str

The unique ID for the project.

name String

The unique ID for the project.

projectId String

The unique ID for the project.

getProject Result

The following output properties are available:

ApiKeys List<GetProjectApiKey>
ClusterCount int
Created string
Id string

The provider-assigned unique ID for this managed resource.

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.

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.

OrgId string

The ID of the organization you want to create the project within. *cluster_count - The number of Atlas clusters deployed in the project. *created - The ISO-8601-formatted timestamp of when Atlas created the project.

  • teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
  • teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
  • api_keys.#.api_key_id - 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.
  • api_keys.#.role_names - Each string in the array represents a project role assigned to the programmatic API key. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
Teams List<GetProjectTeam>
Name string

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

ProjectId string
ApiKeys []GetProjectApiKey
ClusterCount int
Created string
Id string

The provider-assigned unique ID for this managed resource.

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.

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.

OrgId string

The ID of the organization you want to create the project within. *cluster_count - The number of Atlas clusters deployed in the project. *created - The ISO-8601-formatted timestamp of when Atlas created the project.

  • teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
  • teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
  • api_keys.#.api_key_id - 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.
  • api_keys.#.role_names - Each string in the array represents a project role assigned to the programmatic API key. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
Teams []GetProjectTeam
Name string

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

ProjectId string
apiKeys List<GetProjectApiKey>
clusterCount Integer
created String
id String

The provider-assigned unique ID for this managed resource.

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.

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.

orgId String

The ID of the organization you want to create the project within. *cluster_count - The number of Atlas clusters deployed in the project. *created - The ISO-8601-formatted timestamp of when Atlas created the project.

  • teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
  • teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
  • api_keys.#.api_key_id - 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.
  • api_keys.#.role_names - Each string in the array represents a project role assigned to the programmatic API key. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
teams List<GetProjectTeam>
name String

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

projectId String
apiKeys GetProjectApiKey[]
clusterCount number
created string
id string

The provider-assigned unique ID for this managed resource.

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.

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.

orgId string

The ID of the organization you want to create the project within. *cluster_count - The number of Atlas clusters deployed in the project. *created - The ISO-8601-formatted timestamp of when Atlas created the project.

  • teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
  • teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
  • api_keys.#.api_key_id - 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.
  • api_keys.#.role_names - Each string in the array represents a project role assigned to the programmatic API key. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
teams GetProjectTeam[]
name string

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

projectId string
api_keys Sequence[GetProjectApiKey]
cluster_count int
created str
id str

The provider-assigned unique ID for this managed resource.

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.

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.

org_id str

The ID of the organization you want to create the project within. *cluster_count - The number of Atlas clusters deployed in the project. *created - The ISO-8601-formatted timestamp of when Atlas created the project.

  • teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
  • teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
  • api_keys.#.api_key_id - 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.
  • api_keys.#.role_names - Each string in the array represents a project role assigned to the programmatic API key. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
teams Sequence[GetProjectTeam]
name str

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

project_id str
apiKeys List<Property Map>
clusterCount Number
created String
id String

The provider-assigned unique ID for this managed resource.

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.

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.

orgId String

The ID of the organization you want to create the project within. *cluster_count - The number of Atlas clusters deployed in the project. *created - The ISO-8601-formatted timestamp of when Atlas created the project.

  • teams.#.team_id - The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
  • teams.#.role_names - Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
  • api_keys.#.api_key_id - 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.
  • api_keys.#.role_names - Each string in the array represents a project role assigned to the programmatic API key. The following are valid roles:
  • GROUP_OWNER
  • GROUP_READ_ONLY
  • GROUP_DATA_ACCESS_ADMIN
  • GROUP_DATA_ACCESS_READ_WRITE
  • GROUP_DATA_ACCESS_READ_ONLY
  • GROUP_CLUSTER_MANAGER
teams List<Property Map>
name String

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

projectId String

Supporting Types

GetProjectApiKey

ApiKeyId string
RoleNames List<string>
ApiKeyId string
RoleNames []string
apiKeyId String
roleNames List<String>
apiKeyId string
roleNames string[]
api_key_id str
role_names Sequence[str]
apiKeyId String
roleNames List<String>

GetProjectTeam

RoleNames List<string>
TeamId string
RoleNames []string
TeamId string
roleNames List<String>
teamId String
roleNames string[]
teamId string
role_names Sequence[str]
team_id str
roleNames List<String>
teamId String

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.