linode logo
Linode v3.12.0, Feb 14 23

linode.getDatabaseMongodb

Provides information about a Linode MongoDB Database.

updates

The following arguments are exported by the updates specification block:

  • day_of_week - The day to perform maintenance. (monday, tuesday, …)

  • duration - The maximum maintenance window time in hours. (1..3)

  • frequency - Whether maintenance occurs on a weekly or monthly basis. (weekly, monthly)

  • hour_of_day - The hour to begin maintenance based in UTC time. (0..23)

  • week_of_month - The week of the month to perform monthly frequency updates. Required for monthly frequency updates. (1..4)

Example Usage

Get information about a MongoDB database

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

return await Deployment.RunAsync(() => 
{
    var my_db = Linode.GetDatabaseMongodb.Invoke(new()
    {
        DatabaseId = 12345,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.LookupDatabaseMongodb(ctx, &linode.LookupDatabaseMongodbArgs{
			DatabaseId: 12345,
		}, 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.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetDatabaseMongodbArgs;
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 my-db = LinodeFunctions.getDatabaseMongodb(GetDatabaseMongodbArgs.builder()
            .databaseId(12345)
            .build());

    }
}
import pulumi
import pulumi_linode as linode

my_db = linode.get_database_mongodb(database_id=12345)
import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const my-db = linode.getDatabaseMongodb({
    databaseId: 12345,
});
variables:
  my-db:
    fn::invoke:
      Function: linode:getDatabaseMongodb
      Arguments:
        databaseId: 12345

Using getDatabaseMongodb

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 getDatabaseMongodb(args: GetDatabaseMongodbArgs, opts?: InvokeOptions): Promise<GetDatabaseMongodbResult>
function getDatabaseMongodbOutput(args: GetDatabaseMongodbOutputArgs, opts?: InvokeOptions): Output<GetDatabaseMongodbResult>
def get_database_mongodb(database_id: Optional[int] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDatabaseMongodbResult
def get_database_mongodb_output(database_id: Optional[pulumi.Input[int]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseMongodbResult]
func LookupDatabaseMongodb(ctx *Context, args *LookupDatabaseMongodbArgs, opts ...InvokeOption) (*LookupDatabaseMongodbResult, error)
func LookupDatabaseMongodbOutput(ctx *Context, args *LookupDatabaseMongodbOutputArgs, opts ...InvokeOption) LookupDatabaseMongodbResultOutput

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

public static class GetDatabaseMongodb 
{
    public static Task<GetDatabaseMongodbResult> InvokeAsync(GetDatabaseMongodbArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseMongodbResult> Invoke(GetDatabaseMongodbInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDatabaseMongodbResult> getDatabaseMongodb(GetDatabaseMongodbArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: linode:index/getDatabaseMongodb:getDatabaseMongodb
  arguments:
    # arguments dictionary

The following arguments are supported:

DatabaseId int

The ID of the MongoDB database.

DatabaseId int

The ID of the MongoDB database.

databaseId Integer

The ID of the MongoDB database.

databaseId number

The ID of the MongoDB database.

database_id int

The ID of the MongoDB database.

databaseId Number

The ID of the MongoDB database.

getDatabaseMongodb Result

The following output properties are available:

AllowLists List<string>

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

CaCert string

The base64-encoded SSL CA certificate for the Managed Database instance.

ClusterSize int

The number of Linode Instance nodes deployed to the Managed Database.

CompressionType string

The type of data compression for this Database. (none, snappy, zlib)

Created string

When this Managed Database was created.

DatabaseId int
Encrypted bool

Whether the Managed Databases is encrypted.

Engine string

The Managed Database engine. (e.g. mongodb)

EngineId string

The Managed Database engine in engine/version format. (e.g. mongodb/4.4.10)

HostPrimary string

The primary host for the Managed Database.

HostSecondary string

The secondary/private network host for the Managed Database.

Id string

The provider-assigned unique ID for this managed resource.

Label string

A unique, user-defined string referring to the Managed Database.

Peers List<string>

A set of peer addresses for this Database.

Port int

The access port for this Managed Database.

Region string

The region that hosts this Linode Managed Database.

ReplicaSet string

Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set.

RootPassword string

The randomly-generated root password for the Managed Database instance.

RootUsername string

The root username for the Managed Database instance.

SslConnection bool

Whether to require SSL credentials to establish a connection to the Managed Database.

Status string

The operating status of the Managed Database.

StorageEngine string

The type of storage engine for this Database. (mmapv1, wiredtiger)

Type string

The Linode Instance type used for the nodes of the Managed Database instance.

Updated string

When this Managed Database was last updated.

Updates List<GetDatabaseMongodbUpdate>
Version string

The Managed Database engine version. (e.g. v8.0.26)

AllowLists []string

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

CaCert string

The base64-encoded SSL CA certificate for the Managed Database instance.

ClusterSize int

The number of Linode Instance nodes deployed to the Managed Database.

CompressionType string

The type of data compression for this Database. (none, snappy, zlib)

Created string

When this Managed Database was created.

DatabaseId int
Encrypted bool

Whether the Managed Databases is encrypted.

Engine string

The Managed Database engine. (e.g. mongodb)

EngineId string

The Managed Database engine in engine/version format. (e.g. mongodb/4.4.10)

HostPrimary string

The primary host for the Managed Database.

HostSecondary string

The secondary/private network host for the Managed Database.

Id string

The provider-assigned unique ID for this managed resource.

Label string

A unique, user-defined string referring to the Managed Database.

Peers []string

A set of peer addresses for this Database.

Port int

The access port for this Managed Database.

Region string

The region that hosts this Linode Managed Database.

ReplicaSet string

Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set.

RootPassword string

The randomly-generated root password for the Managed Database instance.

RootUsername string

The root username for the Managed Database instance.

SslConnection bool

Whether to require SSL credentials to establish a connection to the Managed Database.

Status string

The operating status of the Managed Database.

StorageEngine string

The type of storage engine for this Database. (mmapv1, wiredtiger)

Type string

The Linode Instance type used for the nodes of the Managed Database instance.

Updated string

When this Managed Database was last updated.

Updates []GetDatabaseMongodbUpdate
Version string

The Managed Database engine version. (e.g. v8.0.26)

allowLists List<String>

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

caCert String

The base64-encoded SSL CA certificate for the Managed Database instance.

clusterSize Integer

The number of Linode Instance nodes deployed to the Managed Database.

compressionType String

The type of data compression for this Database. (none, snappy, zlib)

created String

When this Managed Database was created.

databaseId Integer
encrypted Boolean

Whether the Managed Databases is encrypted.

engine String

The Managed Database engine. (e.g. mongodb)

engineId String

The Managed Database engine in engine/version format. (e.g. mongodb/4.4.10)

hostPrimary String

The primary host for the Managed Database.

hostSecondary String

The secondary/private network host for the Managed Database.

id String

The provider-assigned unique ID for this managed resource.

label String

A unique, user-defined string referring to the Managed Database.

peers List<String>

A set of peer addresses for this Database.

port Integer

The access port for this Managed Database.

region String

The region that hosts this Linode Managed Database.

replicaSet String

Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set.

rootPassword String

The randomly-generated root password for the Managed Database instance.

rootUsername String

The root username for the Managed Database instance.

sslConnection Boolean

Whether to require SSL credentials to establish a connection to the Managed Database.

status String

The operating status of the Managed Database.

storageEngine String

The type of storage engine for this Database. (mmapv1, wiredtiger)

type String

The Linode Instance type used for the nodes of the Managed Database instance.

updated String

When this Managed Database was last updated.

updates List<GetDatabaseMongodbUpdate>
version String

The Managed Database engine version. (e.g. v8.0.26)

allowLists string[]

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

caCert string

The base64-encoded SSL CA certificate for the Managed Database instance.

clusterSize number

The number of Linode Instance nodes deployed to the Managed Database.

compressionType string

The type of data compression for this Database. (none, snappy, zlib)

created string

When this Managed Database was created.

databaseId number
encrypted boolean

Whether the Managed Databases is encrypted.

engine string

The Managed Database engine. (e.g. mongodb)

engineId string

The Managed Database engine in engine/version format. (e.g. mongodb/4.4.10)

hostPrimary string

The primary host for the Managed Database.

hostSecondary string

The secondary/private network host for the Managed Database.

id string

The provider-assigned unique ID for this managed resource.

label string

A unique, user-defined string referring to the Managed Database.

peers string[]

A set of peer addresses for this Database.

port number

The access port for this Managed Database.

region string

The region that hosts this Linode Managed Database.

replicaSet string

Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set.

rootPassword string

The randomly-generated root password for the Managed Database instance.

rootUsername string

The root username for the Managed Database instance.

sslConnection boolean

Whether to require SSL credentials to establish a connection to the Managed Database.

status string

The operating status of the Managed Database.

storageEngine string

The type of storage engine for this Database. (mmapv1, wiredtiger)

type string

The Linode Instance type used for the nodes of the Managed Database instance.

updated string

When this Managed Database was last updated.

updates GetDatabaseMongodbUpdate[]
version string

The Managed Database engine version. (e.g. v8.0.26)

allow_lists Sequence[str]

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

ca_cert str

The base64-encoded SSL CA certificate for the Managed Database instance.

cluster_size int

The number of Linode Instance nodes deployed to the Managed Database.

compression_type str

The type of data compression for this Database. (none, snappy, zlib)

created str

When this Managed Database was created.

database_id int
encrypted bool

Whether the Managed Databases is encrypted.

engine str

The Managed Database engine. (e.g. mongodb)

engine_id str

The Managed Database engine in engine/version format. (e.g. mongodb/4.4.10)

host_primary str

The primary host for the Managed Database.

host_secondary str

The secondary/private network host for the Managed Database.

id str

The provider-assigned unique ID for this managed resource.

label str

A unique, user-defined string referring to the Managed Database.

peers Sequence[str]

A set of peer addresses for this Database.

port int

The access port for this Managed Database.

region str

The region that hosts this Linode Managed Database.

replica_set str

Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set.

root_password str

The randomly-generated root password for the Managed Database instance.

root_username str

The root username for the Managed Database instance.

ssl_connection bool

Whether to require SSL credentials to establish a connection to the Managed Database.

status str

The operating status of the Managed Database.

storage_engine str

The type of storage engine for this Database. (mmapv1, wiredtiger)

type str

The Linode Instance type used for the nodes of the Managed Database instance.

updated str

When this Managed Database was last updated.

updates Sequence[GetDatabaseMongodbUpdate]
version str

The Managed Database engine version. (e.g. v8.0.26)

allowLists List<String>

A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.

caCert String

The base64-encoded SSL CA certificate for the Managed Database instance.

clusterSize Number

The number of Linode Instance nodes deployed to the Managed Database.

compressionType String

The type of data compression for this Database. (none, snappy, zlib)

created String

When this Managed Database was created.

databaseId Number
encrypted Boolean

Whether the Managed Databases is encrypted.

engine String

The Managed Database engine. (e.g. mongodb)

engineId String

The Managed Database engine in engine/version format. (e.g. mongodb/4.4.10)

hostPrimary String

The primary host for the Managed Database.

hostSecondary String

The secondary/private network host for the Managed Database.

id String

The provider-assigned unique ID for this managed resource.

label String

A unique, user-defined string referring to the Managed Database.

peers List<String>

A set of peer addresses for this Database.

port Number

The access port for this Managed Database.

region String

The region that hosts this Linode Managed Database.

replicaSet String

Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set.

rootPassword String

The randomly-generated root password for the Managed Database instance.

rootUsername String

The root username for the Managed Database instance.

sslConnection Boolean

Whether to require SSL credentials to establish a connection to the Managed Database.

status String

The operating status of the Managed Database.

storageEngine String

The type of storage engine for this Database. (mmapv1, wiredtiger)

type String

The Linode Instance type used for the nodes of the Managed Database instance.

updated String

When this Managed Database was last updated.

updates List<Property Map>
version String

The Managed Database engine version. (e.g. v8.0.26)

Supporting Types

GetDatabaseMongodbUpdate

dayOfWeek String
duration Integer
frequency String
hourOfDay Integer
weekOfMonth Integer
dayOfWeek string
duration number
frequency string
hourOfDay number
weekOfMonth number
dayOfWeek String
duration Number
frequency String
hourOfDay Number
weekOfMonth Number

Package Details

Repository
Linode pulumi/pulumi-linode
License
Apache-2.0
Notes

This Pulumi package is based on the linode Terraform Provider.