MongoDB Atlas v3.8.1, Jun 6 23

MongoDB Atlas v3.8.1 published on Tuesday, Jun 6, 2023 by Pulumi

mongodbatlas.getProject

Explore with Pulumi AI

MongoDB Atlas v3.8.1 published on Tuesday, Jun 6, 2023 by Pulumi

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.
IMPORTANT: Either project_id or name must be configurated.
ProjectId string: The unique ID for the project.

Name string: The unique ID for the project.
IMPORTANT: Either project_id or name must be configurated.
ProjectId string: The unique ID for the project.

name String: The unique ID for the project.
IMPORTANT: Either project_id or name must be configurated.
projectId String: The unique ID for the project.

name string: The unique ID for the project.
IMPORTANT: Either project_id or name must be configurated.
projectId string: The unique ID for the project.

name str: The unique ID for the project.
IMPORTANT: Either project_id or name must be configurated.
project_id str: The unique ID for the project.

name String: The unique ID for the project.
IMPORTANT: Either project_id or name must be configurated.
projectId String: The unique ID for the project.

getProject Result

The following output properties are available:

ApiKeys List<GetProjectApiKey>

ClusterCount int

The number of Atlas clusters deployed in the project.

Created string

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:

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.

RegionUsageRestrictions string

If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.

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 []GetProjectApiKeyType

ClusterCount int

The number of Atlas clusters deployed in the project.

Created string

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:

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

OrgId string

The ID of the organization you want to create the project within.

RegionUsageRestrictions string

If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.

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

The number of Atlas clusters deployed in the project.

created String

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:

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

orgId String

The ID of the organization you want to create the project within.

regionUsageRestrictions String

If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.

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

The number of Atlas clusters deployed in the project.

created string

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:

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

orgId string

The ID of the organization you want to create the project within.

regionUsageRestrictions string

If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.

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

The number of Atlas clusters deployed in the project.

created str

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:

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

org_id str

The ID of the organization you want to create the project within.

region_usage_restrictions str

If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.

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

The number of Atlas clusters deployed in the project.

created String

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:

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

orgId String

The ID of the organization you want to create the project within.

regionUsageRestrictions String

If GOV_REGIONS_ONLY the project can be used for government regions only, otherwise defaults to standard regions. For more information see MongoDB Atlas for Government.

teams List<Property Map>

name String