MongoDB Atlas
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 str
The unique ID for the project.
- project_
id str The unique ID for the project.
getProject Result
The following output properties are available:
- Api
Keys List<GetProject Api Key> - Cluster
Count int - Created string
- Id string
The provider-assigned unique ID for this managed resource.
- Is
Collect boolDatabase Specifics Statistics Enabled Flag that indicates whether to enable statistics in cluster metrics collection for the project.
- Is
Data boolExplorer Enabled 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 boolAdvisor Enabled 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 boolPerformance Panel Enabled 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 boolAdvisor Enabled 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 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<Get
Project Team> - Name string
The name of the project you want to create. (Cannot be changed via this Provider after creation.)
- Project
Id string
- Api
Keys []GetProject Api Key - Cluster
Count int - Created string
- Id string
The provider-assigned unique ID for this managed resource.
- Is
Collect boolDatabase Specifics Statistics Enabled Flag that indicates whether to enable statistics in cluster metrics collection for the project.
- Is
Data boolExplorer Enabled 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 boolAdvisor Enabled 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 boolPerformance Panel Enabled 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 boolAdvisor Enabled 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 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
[]Get
Project Team - Name string
The name of the project you want to create. (Cannot be changed via this Provider after creation.)
- Project
Id string
- api
Keys List<GetProject Api Key> - cluster
Count Integer - created String
- id String
The provider-assigned unique ID for this managed resource.
- is
Collect BooleanDatabase Specifics Statistics Enabled Flag that indicates whether to enable statistics in cluster metrics collection for the project.
- is
Data BooleanExplorer Enabled 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 BooleanAdvisor Enabled 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 BooleanPerformance Panel Enabled 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 BooleanAdvisor Enabled 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 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<Get
Project Team> - name String
The name of the project you want to create. (Cannot be changed via this Provider after creation.)
- project
Id String
- api
Keys GetProject Api Key[] - cluster
Count number - created string
- id string
The provider-assigned unique ID for this managed resource.
- is
Collect booleanDatabase Specifics Statistics Enabled Flag that indicates whether to enable statistics in cluster metrics collection for the project.
- is
Data booleanExplorer Enabled 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 booleanAdvisor Enabled 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 booleanPerformance Panel Enabled 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 booleanAdvisor Enabled 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 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
Get
Project Team[] - name string
The name of the project you want to create. (Cannot be changed via this Provider after creation.)
- project
Id string
- api_
keys Sequence[GetProject Api Key] - cluster_
count int - created str
- id str
The provider-assigned unique ID for this managed resource.
- is_
collect_ booldatabase_ specifics_ statistics_ enabled Flag that indicates whether to enable statistics in cluster metrics collection for the project.
- is_
data_ boolexplorer_ enabled 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_ booladvisor_ enabled 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_ boolperformance_ panel_ enabled 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_ booladvisor_ enabled 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[Get
Project Team] - name str
The name of the project you want to create. (Cannot be changed via this Provider after creation.)
- project_
id str
- api
Keys List<Property Map> - cluster
Count Number - created String
- id String
The provider-assigned unique ID for this managed resource.
- is
Collect BooleanDatabase Specifics Statistics Enabled Flag that indicates whether to enable statistics in cluster metrics collection for the project.
- is
Data BooleanExplorer Enabled 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 BooleanAdvisor Enabled 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 BooleanPerformance Panel Enabled 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 BooleanAdvisor Enabled 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 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.)
- project
Id String
Supporting Types
GetProjectApiKey
- api_
key_ strid - role_
names Sequence[str]
GetProjectTeam
- 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.