MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.getServerlessInstances

Explore with Pulumi AI

mongodbatlas.getServerlessInstances describe all serverless instances. This represents serverless instances that have been created for the specified group id.

NOTE: Serverless instances do not support some Atlas features at this time. For a full list of unsupported features, see Serverless Instance Limitations.

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

Example Usage

using System.Collections.Generic;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var dataServerless = Mongodbatlas.GetServerlessInstances.Invoke(new()
    {
        ProjectId = "<PROJECT_ID",
    });

});

package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupServerlessInstances(ctx, &mongodbatlas.LookupServerlessInstancesArgs{
			ProjectId: "<PROJECT_ID",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetServerlessInstancesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var dataServerless = MongodbatlasFunctions.getServerlessInstances(GetServerlessInstancesArgs.builder()
            .projectId("<PROJECT_ID")
            .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

data_serverless = mongodbatlas.get_serverless_instances(project_id="<PROJECT_ID")

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const dataServerless = mongodbatlas.getServerlessInstances({
    projectId: "<PROJECT_ID",
});

variables:
  dataServerless:
    fn::invoke:
      Function: mongodbatlas:getServerlessInstances
      Arguments:
        projectId: <PROJECT_ID

Using getServerlessInstances

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 getServerlessInstances(args: GetServerlessInstancesArgs, opts?: InvokeOptions): Promise<GetServerlessInstancesResult>
function getServerlessInstancesOutput(args: GetServerlessInstancesOutputArgs, opts?: InvokeOptions): Output<GetServerlessInstancesResult>

def get_serverless_instances(project_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetServerlessInstancesResult
def get_serverless_instances_output(project_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetServerlessInstancesResult]

func LookupServerlessInstances(ctx *Context, args *LookupServerlessInstancesArgs, opts ...InvokeOption) (*LookupServerlessInstancesResult, error)
func LookupServerlessInstancesOutput(ctx *Context, args *LookupServerlessInstancesOutputArgs, opts ...InvokeOption) LookupServerlessInstancesResultOutput

> Note: This function is named LookupServerlessInstances in the Go SDK.

public static class GetServerlessInstances 
{
    public static Task<GetServerlessInstancesResult> InvokeAsync(GetServerlessInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetServerlessInstancesResult> Invoke(GetServerlessInstancesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetServerlessInstancesResult> getServerlessInstances(GetServerlessInstancesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getServerlessInstances:getServerlessInstances
  arguments:
    # arguments dictionary

The following arguments are supported:

ProjectId string: Unique identifier for the project that contains the specified cluster.

ProjectId string: Unique identifier for the project that contains the specified cluster.

projectId String: Unique identifier for the project that contains the specified cluster.

projectId string: Unique identifier for the project that contains the specified cluster.

project_id str: Unique identifier for the project that contains the specified cluster.

projectId String: Unique identifier for the project that contains the specified cluster.

getServerlessInstances Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results List<GetServerlessInstancesResult>: A list where each represents a search index.

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string
Results []GetServerlessInstancesResult: A list where each represents a search index.

id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<GetServerlessInstancesResult>: A list where each represents a search index.

id string: The provider-assigned unique ID for this managed resource.
projectId string
results GetServerlessInstancesResult[]: A list where each represents a search index.

id str: The provider-assigned unique ID for this managed resource.
project_id str
results Sequence[GetServerlessInstancesResult]: A list where each represents a search index.

id String: The provider-assigned unique ID for this managed resource.
projectId String
results List<Property Map>: A list where each represents a search index.

Supporting Types

GetServerlessInstancesResult

ConnectionStringsPrivateEndpointSrvs List<string>
ConnectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
ContinuousBackupEnabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup.
CreateDate string
Id string: Unique 24-hexadecimal digit string that identifies the serverless instance.
Links List<GetServerlessInstancesResultLink>
MongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
Name string: (Required) Human-readable label that identifies your serverless instance.
ProjectId string: Unique identifier for the project that contains the specified cluster.
ProviderSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
ProviderSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
ProviderSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
StateName string: Stage of deployment of this serverless instance when the resource made its request.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

ConnectionStringsPrivateEndpointSrvs []string
ConnectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
ContinuousBackupEnabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup.
CreateDate string
Id string: Unique 24-hexadecimal digit string that identifies the serverless instance.
Links []GetServerlessInstancesResultLink
MongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
Name string: (Required) Human-readable label that identifies your serverless instance.
ProjectId string: Unique identifier for the project that contains the specified cluster.
ProviderSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
ProviderSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
ProviderSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
StateName string: Stage of deployment of this serverless instance when the resource made its request.
TerminationProtectionEnabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connectionStringsPrivateEndpointSrvs List<String>
connectionStringsStandardSrv String: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuousBackupEnabled Boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup.
createDate String
id String: Unique 24-hexadecimal digit string that identifies the serverless instance.
links List<GetServerlessInstancesResultLink>
mongoDbVersion String: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name String: (Required) Human-readable label that identifies your serverless instance.
projectId String: Unique identifier for the project that contains the specified cluster.
providerSettingsBackingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName String: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName String: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
stateName String: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connectionStringsPrivateEndpointSrvs string[]
connectionStringsStandardSrv string: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuousBackupEnabled boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup.
createDate string
id string: Unique 24-hexadecimal digit string that identifies the serverless instance.
links GetServerlessInstancesResultLink[]
mongoDbVersion string: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name string: (Required) Human-readable label that identifies your serverless instance.
projectId string: Unique identifier for the project that contains the specified cluster.
providerSettingsBackingProviderName string: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName string: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName string: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
stateName string: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connection_strings_private_endpoint_srvs Sequence[str]
connection_strings_standard_srv str: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuous_backup_enabled bool: Flag that indicates whether the serverless instance uses Serverless Continuous Backup.
create_date str
id str: Unique 24-hexadecimal digit string that identifies the serverless instance.
links Sequence[GetServerlessInstancesResultLink]
mongo_db_version str: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name str: (Required) Human-readable label that identifies your serverless instance.
project_id str: Unique identifier for the project that contains the specified cluster.
provider_settings_backing_provider_name str: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
provider_settings_provider_name str: Cloud service provider that applies to the provisioned the serverless instance.
provider_settings_region_name str: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
state_name str: Stage of deployment of this serverless instance when the resource made its request.
termination_protection_enabled bool: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

connectionStringsPrivateEndpointSrvs List<String>
connectionStringsStandardSrv String: Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
continuousBackupEnabled Boolean: Flag that indicates whether the serverless instance uses Serverless Continuous Backup.
createDate String
id String: Unique 24-hexadecimal digit string that identifies the serverless instance.
links List<Property Map>
mongoDbVersion String: Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
name String: (Required) Human-readable label that identifies your serverless instance.
projectId String: Unique identifier for the project that contains the specified cluster.
providerSettingsBackingProviderName String: Cloud service provider on which MongoDB Cloud provisioned the serverless instance.
providerSettingsProviderName String: Cloud service provider that applies to the provisioned the serverless instance.
providerSettingsRegionName String: Human-readable label that identifies the physical location of your MongoDB serverless instance. The region you choose can affect network latency for clients accessing your databases.
stateName String: Stage of deployment of this serverless instance when the resource made its request.
terminationProtectionEnabled Boolean: Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.

GetServerlessInstancesResultLink

Href string
Rel string

Href string
Rel string

href String
rel String

href string
rel string

href str
rel str

href String
rel String

Package Details

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