Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getProject
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getProject

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    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 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:

    ClusterCount int
    The number of Atlas clusters deployed in the project.
    Created string
    The ISO-8601-formatted timestamp of when Atlas created the project.
    Id string
    IpAddresses GetProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    IsExtendedStorageSizesEnabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project.
    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.
    Limits List<GetProjectLimit>
    The limits for the specified project. See Limits.
    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>
    Returns all teams to which the authenticated user has access in the project. See Teams.
    Name string
    Human-readable label that identifies this project limit.
    ProjectId string
    ClusterCount int
    The number of Atlas clusters deployed in the project.
    Created string
    The ISO-8601-formatted timestamp of when Atlas created the project.
    Id string
    IpAddresses GetProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    IsExtendedStorageSizesEnabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project.
    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.
    Limits []GetProjectLimit
    The limits for the specified project. See Limits.
    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
    Returns all teams to which the authenticated user has access in the project. See Teams.
    Name string
    Human-readable label that identifies this project limit.
    ProjectId string
    clusterCount Integer
    The number of Atlas clusters deployed in the project.
    created String
    The ISO-8601-formatted timestamp of when Atlas created the project.
    id String
    ipAddresses GetProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    isExtendedStorageSizesEnabled Boolean
    Flag that indicates whether to enable extended storage sizes for the specified project.
    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.
    limits List<GetProjectLimit>
    The limits for the specified project. See Limits.
    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>
    Returns all teams to which the authenticated user has access in the project. See Teams.
    name String
    Human-readable label that identifies this project limit.
    projectId String
    clusterCount number
    The number of Atlas clusters deployed in the project.
    created string
    The ISO-8601-formatted timestamp of when Atlas created the project.
    id string
    ipAddresses GetProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    isExtendedStorageSizesEnabled boolean
    Flag that indicates whether to enable extended storage sizes for the specified project.
    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.
    limits GetProjectLimit[]
    The limits for the specified project. See Limits.
    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[]
    Returns all teams to which the authenticated user has access in the project. See Teams.
    name string
    Human-readable label that identifies this project limit.
    projectId string
    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.
    id str
    ip_addresses GetProjectIpAddresses
    IP addresses in a project categorized by services. See IP Addresses.
    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_extended_storage_sizes_enabled bool
    Flag that indicates whether to enable extended storage sizes for the specified project.
    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.
    limits Sequence[GetProjectLimit]
    The limits for the specified project. See Limits.
    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]
    Returns all teams to which the authenticated user has access in the project. See Teams.
    name str
    Human-readable label that identifies this project limit.
    project_id str
    clusterCount Number
    The number of Atlas clusters deployed in the project.
    created String
    The ISO-8601-formatted timestamp of when Atlas created the project.
    id String
    ipAddresses Property Map
    IP addresses in a project categorized by services. See IP Addresses.
    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.
    isExtendedStorageSizesEnabled Boolean
    Flag that indicates whether to enable extended storage sizes for the specified project.
    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.
    limits List<Property Map>
    The limits for the specified project. See Limits.
    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>
    Returns all teams to which the authenticated user has access in the project. See Teams.
    name String
    Human-readable label that identifies this project limit.
    projectId String

    Supporting Types

    GetProjectIpAddresses

    GetProjectIpAddressesServices

    GetProjectIpAddressesServicesCluster

    ClusterName string
    Inbounds List<string>
    Outbounds List<string>
    ClusterName string
    Inbounds []string
    Outbounds []string
    clusterName String
    inbounds List<String>
    outbounds List<String>
    clusterName string
    inbounds string[]
    outbounds string[]
    cluster_name str
    inbounds Sequence[str]
    outbounds Sequence[str]
    clusterName String
    inbounds List<String>
    outbounds List<String>

    GetProjectLimit

    CurrentUsage int
    Amount that indicates the current usage of the limit.
    DefaultLimit int
    Default value of the limit.
    MaximumLimit int
    Maximum value of the limit.
    Name string

    The unique ID for the project.

    IMPORTANT: Either project_id or name must be configurated.

    Value int
    Amount the limit is set to.
    CurrentUsage int
    Amount that indicates the current usage of the limit.
    DefaultLimit int
    Default value of the limit.
    MaximumLimit int
    Maximum value of the limit.
    Name string

    The unique ID for the project.

    IMPORTANT: Either project_id or name must be configurated.

    Value int
    Amount the limit is set to.
    currentUsage Integer
    Amount that indicates the current usage of the limit.
    defaultLimit Integer
    Default value of the limit.
    maximumLimit Integer
    Maximum value of the limit.
    name String

    The unique ID for the project.

    IMPORTANT: Either project_id or name must be configurated.

    value Integer
    Amount the limit is set to.
    currentUsage number
    Amount that indicates the current usage of the limit.
    defaultLimit number
    Default value of the limit.
    maximumLimit number
    Maximum value of the limit.
    name string

    The unique ID for the project.

    IMPORTANT: Either project_id or name must be configurated.

    value number
    Amount the limit is set to.
    current_usage int
    Amount that indicates the current usage of the limit.
    default_limit int
    Default value of the limit.
    maximum_limit int
    Maximum value of the limit.
    name str

    The unique ID for the project.

    IMPORTANT: Either project_id or name must be configurated.

    value int
    Amount the limit is set to.
    currentUsage Number
    Amount that indicates the current usage of the limit.
    defaultLimit Number
    Default value of the limit.
    maximumLimit Number
    Maximum value of the limit.
    name String

    The unique ID for the project.

    IMPORTANT: Either project_id or name must be configurated.

    value Number
    Amount the limit is set to.

    GetProjectTeam

    RoleNames List<string>
    Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
    TeamId string
    The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
    RoleNames []string
    Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
    TeamId string
    The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
    roleNames List<String>
    Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
    teamId String
    The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
    roleNames string[]
    Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
    teamId string
    The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
    role_names Sequence[str]
    Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
    team_id str
    The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.
    roleNames List<String>
    Each string in the array represents a project role assigned to the team. Every user associated with the team inherits these roles. The MongoDB Documentation describes the roles a user can have.
    teamId String
    The unique identifier of the team you want to associate with the project. The team and project must share the same parent organization.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas