Linode
getDatabaseMongodb
Provides information about a Linode MongoDB Database.
Attributes
The linode.DatabaseMongodb
data source exports the following attributes:
allow_list
- 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
- The base64-encoded SSL CA certificate for the Managed Database instance.cluster_size
- The number of Linode Instance nodes deployed to the Managed Database.compression_type
- The type of data compression for this Database. (none
,snappy
,zlib
)created
- When this Managed Database was created.encrypted
- Whether the Managed Databases is encrypted.engine
- The Managed Database engine. (e.g.mongodb
)engine_id
- The Managed Database engine in engine/version format. (e.g.mongodb/4.4.10
)host_primary
- The primary host for the Managed Database.host_secondary
- The secondary/private network host for the Managed Database.label
- A unique, user-defined string referring to the Managed Database.peers
- A set of peer addresses for this Database.port
- The access port for this Managed Database.replica_set
- Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set.region
- The region that hosts this Linode Managed Database.root_password
- The randomly-generated root password for the Managed Database instance.root_username
- The root username for the Managed Database instance.ssl_connection
- Whether to require SSL credentials to establish a connection to the Managed Database.storage_engine
- The type of storage engine for this Database. (mmapv1
,wiredtiger
)status
- The operating status of the Managed Database.type
- The Linode Instance type used for the nodes of the Managed Database instance.updated
- When this Managed Database was last updated.updates
- (Optional) Configuration settings for automated patch update maintenance for the Managed Database.version
- The Managed Database engine version. (e.g.v8.0.26
)
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 formonthly
frequency updates. (1
..4
)
Example Usage
using Pulumi;
using Linode = Pulumi.Linode;
class MyStack : Stack
{
public MyStack()
{
var my_db = Output.Create(Linode.GetDatabaseMongodb.InvokeAsync(new Linode.GetDatabaseMongodbArgs
{
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, &GetDatabaseMongodbArgs{
DatabaseId: 12345,
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var my-db = Output.of(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 = pulumi.output(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:
- Database
Id int The ID of the MongoDB database.
- Database
Id int The ID of the MongoDB database.
- database
Id Integer The ID of the MongoDB database.
- database
Id number The ID of the MongoDB database.
- database_
id int The ID of the MongoDB database.
- database
Id Number The ID of the MongoDB database.
getDatabaseMongodb Result
The following output properties are available:
- Allow
Lists List<string> - Ca
Cert string - Cluster
Size int - Compression
Type string - Created string
- Database
Id int - Encrypted bool
- Engine string
- Engine
Id string - Host
Primary string - Host
Secondary string - Id string
The provider-assigned unique ID for this managed resource.
- Label string
- Peers List<string>
- Port int
- Region string
- Replica
Set string - Root
Password string - Root
Username string - Ssl
Connection bool - Status string
- Storage
Engine string - Type string
- Updated string
- Updates
List<Get
Database Mongodb Update> - Version string
- Allow
Lists []string - Ca
Cert string - Cluster
Size int - Compression
Type string - Created string
- Database
Id int - Encrypted bool
- Engine string
- Engine
Id string - Host
Primary string - Host
Secondary string - Id string
The provider-assigned unique ID for this managed resource.
- Label string
- Peers []string
- Port int
- Region string
- Replica
Set string - Root
Password string - Root
Username string - Ssl
Connection bool - Status string
- Storage
Engine string - Type string
- Updated string
- Updates
[]Get
Database Mongodb Update - Version string
- allow
Lists List<String> - ca
Cert String - cluster
Size Integer - compression
Type String - created String
- database
Id Integer - encrypted Boolean
- engine String
- engine
Id String - host
Primary String - host
Secondary String - id String
The provider-assigned unique ID for this managed resource.
- label String
- peers List<String>
- port Integer
- region String
- replica
Set String - root
Password String - root
Username String - ssl
Connection Boolean - status String
- storage
Engine String - type String
- updated String
- updates
List<Get
Database Mongodb Update> - version String
- allow
Lists string[] - ca
Cert string - cluster
Size number - compression
Type string - created string
- database
Id number - encrypted boolean
- engine string
- engine
Id string - host
Primary string - host
Secondary string - id string
The provider-assigned unique ID for this managed resource.
- label string
- peers string[]
- port number
- region string
- replica
Set string - root
Password string - root
Username string - ssl
Connection boolean - status string
- storage
Engine string - type string
- updated string
- updates
Get
Database Mongodb Update[] - version string
- allow_
lists Sequence[str] - ca_
cert str - cluster_
size int - compression_
type str - created str
- database_
id int - encrypted bool
- engine str
- engine_
id str - host_
primary str - host_
secondary str - id str
The provider-assigned unique ID for this managed resource.
- label str
- peers Sequence[str]
- port int
- region str
- replica_
set str - root_
password str - root_
username str - ssl_
connection bool - status str
- storage_
engine str - type str
- updated str
- updates
Sequence[Get
Database Mongodb Update] - version str
- allow
Lists List<String> - ca
Cert String - cluster
Size Number - compression
Type String - created String
- database
Id Number - encrypted Boolean
- engine String
- engine
Id String - host
Primary String - host
Secondary String - id String
The provider-assigned unique ID for this managed resource.
- label String
- peers List<String>
- port Number
- region String
- replica
Set String - root
Password String - root
Username String - ssl
Connection Boolean - status String
- storage
Engine String - type String
- updated String
- updates List<Property Map>
- version String
Supporting Types
GetDatabaseMongodbUpdate
- Day
Of stringWeek - Duration int
- Frequency string
- Hour
Of intDay - Week
Of intMonth
- Day
Of stringWeek - Duration int
- Frequency string
- Hour
Of intDay - Week
Of intMonth
- day
Of StringWeek - duration Integer
- frequency String
- hour
Of IntegerDay - week
Of IntegerMonth
- day
Of stringWeek - duration number
- frequency string
- hour
Of numberDay - week
Of numberMonth
- day_
of_ strweek - duration int
- frequency str
- hour_
of_ intday - week_
of_ intmonth
- day
Of StringWeek - duration Number
- frequency String
- hour
Of NumberDay - week
Of NumberMonth
Package Details
- Repository
- https://github.com/pulumi/pulumi-linode
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
linode
Terraform Provider.