Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

GetProjects

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

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

Example Usage

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 = pulumi.output(mongodbatlas.getProject({
    itemsPerPage: 5,
    pageNum: 1,
}, { async: true }));

Using GetProjects

function getProjects(args: GetProjectsArgs, opts?: InvokeOptions): Promise<GetProjectsResult>
def get_projects(items_per_page: Optional[int] = None, page_num: Optional[int] = None, opts: Optional[InvokeOptions] = None) -> GetProjectsResult
func GetProjects(ctx *Context, args *GetProjectsArgs, opts ...InvokeOption) (*GetProjectsResult, error)
public static class GetProjects {
    public static Task<GetProjectsResult> InvokeAsync(GetProjectsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ItemsPerPage int

Number of items to return per page, up to a maximum of 500. Defaults to 100.

PageNum int

The page to return. Defaults to 1.

ItemsPerPage int

Number of items to return per page, up to a maximum of 500. Defaults to 100.

PageNum int

The page to return. Defaults to 1.

itemsPerPage number

Number of items to return per page, up to a maximum of 500. Defaults to 100.

pageNum number

The page to return. Defaults to 1.

items_per_page int

Number of items to return per page, up to a maximum of 500. Defaults to 100.

page_num int

The page to return. Defaults to 1.

GetProjects Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

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

The provider-assigned unique ID for this managed resource.

Results []GetProjectsResultType
TotalCount int
ItemsPerPage int
PageNum int
id string

The provider-assigned unique ID for this managed resource.

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

The provider-assigned unique ID for this managed resource.

results Sequence[GetProjectsResult]
total_count int
items_per_page int
page_num int

Supporting Types

GetProjectsResult

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

ClusterCount int
Created string
Id string

Autogenerated Unique ID for this data source.

Name string

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

OrgId string

The ID of the organization you want to create the project within. *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<GetProjectsResultTeamArgs>
ClusterCount int
Created string
Id string

Autogenerated Unique ID for this data source.

Name string

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

OrgId string

The ID of the organization you want to create the project within. *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 []GetProjectsResultTeam
clusterCount number
created string
id string

Autogenerated Unique ID for this data source.

name string

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

orgId string

The ID of the organization you want to create the project within. *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 GetProjectsResultTeam[]
cluster_count int
created str
id str

Autogenerated Unique ID for this data source.

name str

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

org_id str

The ID of the organization you want to create the project within. *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 Sequence[GetProjectsResultTeamArgs]

GetProjectsResultTeam

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

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

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.