1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. ServerlessInstance
MongoDB Atlas v3.16.0 published on Wednesday, Jun 12, 2024 by Pulumi

mongodbatlas.ServerlessInstance

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.0 published on Wednesday, Jun 12, 2024 by Pulumi

    mongodbatlas.ServerlessInstance provides a Serverless Instance resource. This allows serverless instances to be created.

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

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.ServerlessInstance("test", {
        projectId: "<PROJECT_ID>",
        name: "<SERVERLESS_INSTANCE_NAME>",
        providerSettingsBackingProviderName: "AWS",
        providerSettingsProviderName: "SERVERLESS",
        providerSettingsRegionName: "US_EAST_1",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.ServerlessInstance("test",
        project_id="<PROJECT_ID>",
        name="<SERVERLESS_INSTANCE_NAME>",
        provider_settings_backing_provider_name="AWS",
        provider_settings_provider_name="SERVERLESS",
        provider_settings_region_name="US_EAST_1")
    
    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.NewServerlessInstance(ctx, "test", &mongodbatlas.ServerlessInstanceArgs{
    			ProjectId:                           pulumi.String("<PROJECT_ID>"),
    			Name:                                pulumi.String("<SERVERLESS_INSTANCE_NAME>"),
    			ProviderSettingsBackingProviderName: pulumi.String("AWS"),
    			ProviderSettingsProviderName:        pulumi.String("SERVERLESS"),
    			ProviderSettingsRegionName:          pulumi.String("US_EAST_1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.ServerlessInstance("test", new()
        {
            ProjectId = "<PROJECT_ID>",
            Name = "<SERVERLESS_INSTANCE_NAME>",
            ProviderSettingsBackingProviderName = "AWS",
            ProviderSettingsProviderName = "SERVERLESS",
            ProviderSettingsRegionName = "US_EAST_1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.ServerlessInstance;
    import com.pulumi.mongodbatlas.ServerlessInstanceArgs;
    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) {
            var test = new ServerlessInstance("test", ServerlessInstanceArgs.builder()
                .projectId("<PROJECT_ID>")
                .name("<SERVERLESS_INSTANCE_NAME>")
                .providerSettingsBackingProviderName("AWS")
                .providerSettingsProviderName("SERVERLESS")
                .providerSettingsRegionName("US_EAST_1")
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:ServerlessInstance
        properties:
          projectId: <PROJECT_ID>
          name: <SERVERLESS_INSTANCE_NAME>
          providerSettingsBackingProviderName: AWS
          providerSettingsProviderName: SERVERLESS
          providerSettingsRegionName: US_EAST_1
    

    NOTE: mongodbatlas.ServerlessInstance and mongodbatlas.PrivatelinkEndpointServiceServerless resources have a circular dependency in some respects.
    That is, the serverless_instance must exist before the privatelink_endpoint_service can be created,
    and the privatelink_endpoint_service must exist before the serverless_instance gets its respective connection_strings_private_endpoint_srv values.

    Because of this, the serverless_instance data source has particular value as a source of the connection_strings_private_endpoint_srv.
    When using the data_source in-tandem with the afforementioned resources, we can create and retrieve the connection_strings_private_endpoint_srv in a single pulumi up.

    Follow this example to setup private connection to a serverless instance using aws vpc and get the connection strings in a single pulumi up

    Create ServerlessInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServerlessInstance(name: string, args: ServerlessInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def ServerlessInstance(resource_name: str,
                           args: ServerlessInstanceArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServerlessInstance(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           project_id: Optional[str] = None,
                           provider_settings_backing_provider_name: Optional[str] = None,
                           provider_settings_provider_name: Optional[str] = None,
                           provider_settings_region_name: Optional[str] = None,
                           auto_indexing: Optional[bool] = None,
                           continuous_backup_enabled: Optional[bool] = None,
                           links: Optional[Sequence[ServerlessInstanceLinkArgs]] = None,
                           name: Optional[str] = None,
                           state_name: Optional[str] = None,
                           tags: Optional[Sequence[ServerlessInstanceTagArgs]] = None,
                           termination_protection_enabled: Optional[bool] = None)
    func NewServerlessInstance(ctx *Context, name string, args ServerlessInstanceArgs, opts ...ResourceOption) (*ServerlessInstance, error)
    public ServerlessInstance(string name, ServerlessInstanceArgs args, CustomResourceOptions? opts = null)
    public ServerlessInstance(String name, ServerlessInstanceArgs args)
    public ServerlessInstance(String name, ServerlessInstanceArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:ServerlessInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ServerlessInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServerlessInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServerlessInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerlessInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerlessInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var serverlessInstanceResource = new Mongodbatlas.ServerlessInstance("serverlessInstanceResource", new()
    {
        ProjectId = "string",
        ProviderSettingsBackingProviderName = "string",
        ProviderSettingsProviderName = "string",
        ProviderSettingsRegionName = "string",
        AutoIndexing = false,
        ContinuousBackupEnabled = false,
        Links = new[]
        {
            new Mongodbatlas.Inputs.ServerlessInstanceLinkArgs
            {
                Href = "string",
                Rel = "string",
            },
        },
        Name = "string",
        StateName = "string",
        Tags = new[]
        {
            new Mongodbatlas.Inputs.ServerlessInstanceTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        TerminationProtectionEnabled = false,
    });
    
    example, err := mongodbatlas.NewServerlessInstance(ctx, "serverlessInstanceResource", &mongodbatlas.ServerlessInstanceArgs{
    	ProjectId:                           pulumi.String("string"),
    	ProviderSettingsBackingProviderName: pulumi.String("string"),
    	ProviderSettingsProviderName:        pulumi.String("string"),
    	ProviderSettingsRegionName:          pulumi.String("string"),
    	AutoIndexing:                        pulumi.Bool(false),
    	ContinuousBackupEnabled:             pulumi.Bool(false),
    	Links: mongodbatlas.ServerlessInstanceLinkArray{
    		&mongodbatlas.ServerlessInstanceLinkArgs{
    			Href: pulumi.String("string"),
    			Rel:  pulumi.String("string"),
    		},
    	},
    	Name:      pulumi.String("string"),
    	StateName: pulumi.String("string"),
    	Tags: mongodbatlas.ServerlessInstanceTagArray{
    		&mongodbatlas.ServerlessInstanceTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	TerminationProtectionEnabled: pulumi.Bool(false),
    })
    
    var serverlessInstanceResource = new ServerlessInstance("serverlessInstanceResource", ServerlessInstanceArgs.builder()
        .projectId("string")
        .providerSettingsBackingProviderName("string")
        .providerSettingsProviderName("string")
        .providerSettingsRegionName("string")
        .autoIndexing(false)
        .continuousBackupEnabled(false)
        .links(ServerlessInstanceLinkArgs.builder()
            .href("string")
            .rel("string")
            .build())
        .name("string")
        .stateName("string")
        .tags(ServerlessInstanceTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .terminationProtectionEnabled(false)
        .build());
    
    serverless_instance_resource = mongodbatlas.ServerlessInstance("serverlessInstanceResource",
        project_id="string",
        provider_settings_backing_provider_name="string",
        provider_settings_provider_name="string",
        provider_settings_region_name="string",
        auto_indexing=False,
        continuous_backup_enabled=False,
        links=[mongodbatlas.ServerlessInstanceLinkArgs(
            href="string",
            rel="string",
        )],
        name="string",
        state_name="string",
        tags=[mongodbatlas.ServerlessInstanceTagArgs(
            key="string",
            value="string",
        )],
        termination_protection_enabled=False)
    
    const serverlessInstanceResource = new mongodbatlas.ServerlessInstance("serverlessInstanceResource", {
        projectId: "string",
        providerSettingsBackingProviderName: "string",
        providerSettingsProviderName: "string",
        providerSettingsRegionName: "string",
        autoIndexing: false,
        continuousBackupEnabled: false,
        links: [{
            href: "string",
            rel: "string",
        }],
        name: "string",
        stateName: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        terminationProtectionEnabled: false,
    });
    
    type: mongodbatlas:ServerlessInstance
    properties:
        autoIndexing: false
        continuousBackupEnabled: false
        links:
            - href: string
              rel: string
        name: string
        projectId: string
        providerSettingsBackingProviderName: string
        providerSettingsProviderName: string
        providerSettingsRegionName: string
        stateName: string
        tags:
            - key: string
              value: string
        terminationProtectionEnabled: false
    

    ServerlessInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ServerlessInstance resource accepts the following input properties:

    ProjectId string
    The ID of the organization or project you want to create the serverless instance within.
    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.
    AutoIndexing bool
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    ContinuousBackupEnabled bool
    Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
    Links List<ServerlessInstanceLink>
    Name string
    Human-readable label that identifies the serverless instance.
    StateName string
    Stage of deployment of this serverless instance when the resource made its request.
    Tags List<ServerlessInstanceTag>
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    ProjectId string
    The ID of the organization or project you want to create the serverless instance within.
    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.
    AutoIndexing bool
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    ContinuousBackupEnabled bool
    Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
    Links []ServerlessInstanceLinkArgs
    Name string
    Human-readable label that identifies the serverless instance.
    StateName string
    Stage of deployment of this serverless instance when the resource made its request.
    Tags []ServerlessInstanceTagArgs
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    projectId String
    The ID of the organization or project you want to create the serverless instance within.
    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.
    autoIndexing Boolean
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    continuousBackupEnabled Boolean
    Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
    links List<ServerlessInstanceLink>
    name String
    Human-readable label that identifies the serverless instance.
    stateName String
    Stage of deployment of this serverless instance when the resource made its request.
    tags List<ServerlessInstanceTag>
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    projectId string
    The ID of the organization or project you want to create the serverless instance within.
    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.
    autoIndexing boolean
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    continuousBackupEnabled boolean
    Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
    links ServerlessInstanceLink[]
    name string
    Human-readable label that identifies the serverless instance.
    stateName string
    Stage of deployment of this serverless instance when the resource made its request.
    tags ServerlessInstanceTag[]
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    project_id str
    The ID of the organization or project you want to create the serverless instance within.
    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.
    auto_indexing bool
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    continuous_backup_enabled bool
    Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
    links Sequence[ServerlessInstanceLinkArgs]
    name str
    Human-readable label that identifies the serverless instance.
    state_name str
    Stage of deployment of this serverless instance when the resource made its request.
    tags Sequence[ServerlessInstanceTagArgs]
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    projectId String
    The ID of the organization or project you want to create the serverless instance within.
    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.
    autoIndexing Boolean
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    continuousBackupEnabled Boolean
    Flag that indicates whether the serverless instance uses Serverless Continuous Backup. If this parameter is false or not used, the serverless instance uses Basic Backup.
    links List<Property Map>
    name String
    Human-readable label that identifies the serverless instance.
    stateName String
    Stage of deployment of this serverless instance when the resource made its request.
    tags List<Property Map>
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServerlessInstance resource produces the following output properties:

    ConnectionStringsPrivateEndpointSrvs List<string>
    List of Serverless Private Endpoint Connections
    ConnectionStringsStandardSrv string
    Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
    CreateDate string
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    MongoDbVersion string
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    ConnectionStringsPrivateEndpointSrvs []string
    List of Serverless Private Endpoint Connections
    ConnectionStringsStandardSrv string
    Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
    CreateDate string
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    Id string
    The provider-assigned unique ID for this managed resource.
    MongoDbVersion string
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    connectionStringsPrivateEndpointSrvs List<String>
    List of Serverless Private Endpoint Connections
    connectionStringsStandardSrv String
    Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
    createDate String
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    mongoDbVersion String
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    connectionStringsPrivateEndpointSrvs string[]
    List of Serverless Private Endpoint Connections
    connectionStringsStandardSrv string
    Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
    createDate string
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    id string
    The provider-assigned unique ID for this managed resource.
    mongoDbVersion string
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    connection_strings_private_endpoint_srvs Sequence[str]
    List of Serverless Private Endpoint Connections
    connection_strings_standard_srv str
    Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
    create_date str
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    id str
    The provider-assigned unique ID for this managed resource.
    mongo_db_version str
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    connectionStringsPrivateEndpointSrvs List<String>
    List of Serverless Private Endpoint Connections
    connectionStringsStandardSrv String
    Public mongodb+srv:// connection string that you can use to connect to this serverless instance.
    createDate String
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    id String
    The provider-assigned unique ID for this managed resource.
    mongoDbVersion String
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.

    Look up Existing ServerlessInstance Resource

    Get an existing ServerlessInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServerlessInstanceState, opts?: CustomResourceOptions): ServerlessInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_indexing: Optional[bool] = None,
            connection_strings_private_endpoint_srvs: Optional[Sequence[str]] = None,
            connection_strings_standard_srv: Optional[str] = None,
            continuous_backup_enabled: Optional[bool] = None,
            create_date: Optional[str] = None,
            links: Optional[Sequence[ServerlessInstanceLinkArgs]] = None,
            mongo_db_version: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            provider_settings_backing_provider_name: Optional[str] = None,
            provider_settings_provider_name: Optional[str] = None,
            provider_settings_region_name: Optional[str] = None,
            state_name: Optional[str] = None,
            tags: Optional[Sequence[ServerlessInstanceTagArgs]] = None,
            termination_protection_enabled: Optional[bool] = None) -> ServerlessInstance
    func GetServerlessInstance(ctx *Context, name string, id IDInput, state *ServerlessInstanceState, opts ...ResourceOption) (*ServerlessInstance, error)
    public static ServerlessInstance Get(string name, Input<string> id, ServerlessInstanceState? state, CustomResourceOptions? opts = null)
    public static ServerlessInstance get(String name, Output<String> id, ServerlessInstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoIndexing bool
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    ConnectionStringsPrivateEndpointSrvs List<string>
    List of Serverless Private Endpoint Connections
    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. If this parameter is false or not used, the serverless instance uses Basic Backup.
    CreateDate string
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    Links List<ServerlessInstanceLink>
    MongoDbVersion string
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    Name string
    Human-readable label that identifies the serverless instance.
    ProjectId string
    The ID of the organization or project you want to create the serverless instance within.
    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.
    Tags List<ServerlessInstanceTag>
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    AutoIndexing bool
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    ConnectionStringsPrivateEndpointSrvs []string
    List of Serverless Private Endpoint Connections
    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. If this parameter is false or not used, the serverless instance uses Basic Backup.
    CreateDate string
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    Links []ServerlessInstanceLinkArgs
    MongoDbVersion string
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    Name string
    Human-readable label that identifies the serverless instance.
    ProjectId string
    The ID of the organization or project you want to create the serverless instance within.
    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.
    Tags []ServerlessInstanceTagArgs
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    autoIndexing Boolean
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    connectionStringsPrivateEndpointSrvs List<String>
    List of Serverless Private Endpoint Connections
    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. If this parameter is false or not used, the serverless instance uses Basic Backup.
    createDate String
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    links List<ServerlessInstanceLink>
    mongoDbVersion String
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    name String
    Human-readable label that identifies the serverless instance.
    projectId String
    The ID of the organization or project you want to create the serverless instance within.
    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.
    tags List<ServerlessInstanceTag>
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    autoIndexing boolean
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    connectionStringsPrivateEndpointSrvs string[]
    List of Serverless Private Endpoint Connections
    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. If this parameter is false or not used, the serverless instance uses Basic Backup.
    createDate string
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    links ServerlessInstanceLink[]
    mongoDbVersion string
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    name string
    Human-readable label that identifies the serverless instance.
    projectId string
    The ID of the organization or project you want to create the serverless instance within.
    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.
    tags ServerlessInstanceTag[]
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    auto_indexing bool
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    connection_strings_private_endpoint_srvs Sequence[str]
    List of Serverless Private Endpoint Connections
    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. If this parameter is false or not used, the serverless instance uses Basic Backup.
    create_date str
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    links Sequence[ServerlessInstanceLinkArgs]
    mongo_db_version str
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    name str
    Human-readable label that identifies the serverless instance.
    project_id str
    The ID of the organization or project you want to create the serverless instance within.
    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.
    tags Sequence[ServerlessInstanceTagArgs]
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.
    autoIndexing Boolean
    Flag that indicates whether the serverless instance uses Serverless Auto Indexing. This parameter defaults to true.
    connectionStringsPrivateEndpointSrvs List<String>
    List of Serverless Private Endpoint Connections
    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. If this parameter is false or not used, the serverless instance uses Basic Backup.
    createDate String
    Timestamp that indicates when MongoDB Cloud created the serverless instance. The timestamp displays in the ISO 8601 date and time format in UTC.
    links List<Property Map>
    mongoDbVersion String
    Version of MongoDB that the serverless instance runs, in <major version>.<minor version> format.
    name String
    Human-readable label that identifies the serverless instance.
    projectId String
    The ID of the organization or project you want to create the serverless instance within.
    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.
    tags List<Property Map>
    Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See below.
    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.

    Supporting Types

    Href string
    Rel string
    Href string
    Rel string
    href String
    rel String
    href string
    rel string
    href str
    rel str
    href String
    rel String

    ServerlessInstanceTag, ServerlessInstanceTagArgs

    Key string
    Constant that defines the set of the tag.
    Value string

    Variable that belongs to the set of the tag.

    To learn more, see Resource Tags.

    Key string
    Constant that defines the set of the tag.
    Value string

    Variable that belongs to the set of the tag.

    To learn more, see Resource Tags.

    key String
    Constant that defines the set of the tag.
    value String

    Variable that belongs to the set of the tag.

    To learn more, see Resource Tags.

    key string
    Constant that defines the set of the tag.
    value string

    Variable that belongs to the set of the tag.

    To learn more, see Resource Tags.

    key str
    Constant that defines the set of the tag.
    value str

    Variable that belongs to the set of the tag.

    To learn more, see Resource Tags.

    key String
    Constant that defines the set of the tag.
    value String

    Variable that belongs to the set of the tag.

    To learn more, see Resource Tags.

    Import

    Serverless Instance can be imported using the group ID and serverless instance name, in the format GROUP_ID-SERVERLESS_INSTANCE_NAME, e.g.

    $ pulumi import mongodbatlas:index/serverlessInstance:ServerlessInstance my_serverless_instance 1112222b3bf99403840e8934-My Serverless Instance
    

    For more information see: MongoDB Atlas API - Serverless Instance Documentation.

    To learn more about importing existing cloud resources, see Importing resources.

    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.16.0 published on Wednesday, Jun 12, 2024 by Pulumi