← All packages

MongoDB Atlas

v3.0.1 published on Monday, Nov 1, 2021 by Pulumi

Source code

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!

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,
}, { async: true }));

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)
}

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 str: The unique ID for the project.
project_id str: The unique ID for the project.

getProject Result

The following output properties are available:

ClusterCount int

Created string

Id string

The provider-assigned unique ID for this managed resource.

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

Teams List<GetProjectTeam>

Name string

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

ProjectId string

ClusterCount int

Created string

Id string

The provider-assigned unique ID for this managed resource.

OrgId string

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

Teams []GetProjectTeam

Name string

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

ProjectId string

clusterCount number

created string

id string

The provider-assigned unique ID for this managed resource.

orgId string

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

teams GetProjectTeam[]

name string

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

projectId string

cluster_count int

created str

id str

The provider-assigned unique ID for this managed resource.

org_id str

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

teams Sequence[GetProjectTeam]

name str