mongodb_instances

Overview

Name	mongodb_instances
Type	Resource
Id	linode.databases.mongodb_instances

Fields

Name	Datatype	Description
id	integer	A unique ID that can be used to identify and reference the Managed Database.
allow_list	array	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. By default, this is an empty array ([]), which blocks all connections (both public and private) to the Managed Database. If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database.
cluster_size	integer	The number of Linode Instance nodes deployed to the Managed Database. Choosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.
compression_type	string	The type of data compression for this Database. Snappy has a lower comparative compression ratio and resource consumption rate. Zlip has a higher comparative compression ratio and resource consumption rate.
created	string	When this Managed Database was created.
encrypted	boolean	Whether the Managed Databases is encrypted.
engine	string	The Managed Database engine type.
hosts	object	The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.
label	string	A unique, user-defined string referring to the Managed Database.
peers	array	An array of peer addresses for this Database.
port	integer	The access port for this Managed Database.
region	string	The Region ID for the Managed Database.
replica_set	string	Label for configuring a MongoDB replica set. Choose the same label on multiple Databases to include them in the same replica set. If null, the Database is not included in any replica set.
ssl_connection	boolean	Whether to require SSL credentials to establish a connection to the Managed Database. Use the Managed MongoDB Database Credentials View (GET /databases/mongodb/instances/{instanceId}/credentials) command for access information.
status	string	The operating status of the Managed Database.
storage_engine	string	The type of storage engine for this Database. Note: MMAPV1 is not available for MongoDB versions 4.0 and above.
type	string	The Linode Instance type used by the Managed Database for its nodes.
updated	string	When this Managed Database was last updated.
updates	object	Configuration settings for automated patch update maintenance for the Managed Database.
version	string	The Managed Database engine version.

Methods

Name	Accessible by	Required Params	Description
getDatabasesMongoDBInstance	SELECT	instanceId	Display information for a single, accessible Managed MongoDB Database. Note: New MongoDB Databases cannot currently be created.
getDatabasesMongoDBInstances	SELECT		Display all accessible Managed MongoDB Databases. Note: New MongoDB Databases cannot currently be created.
deleteDatabasesMongoDBInstance	DELETE	instanceId	Remove a Managed MongoDB Database from your Account. Requires read_write access to the Database. The Database must have an active, failed, or degraded status to perform this command. Only unrestricted Users can access this command, and have access regardless of the acting token's OAuth scopes. Note: New MongoDB Databases cannot currently be created.
_getDatabasesMongoDBInstance	EXEC	instanceId	Display information for a single, accessible Managed MongoDB Database. Note: New MongoDB Databases cannot currently be created.
_getDatabasesMongoDBInstances	EXEC		Display all accessible Managed MongoDB Databases. Note: New MongoDB Databases cannot currently be created.
postDatabasesMongoDBInstancePatch	EXEC	instanceId	Apply security patches and updates to the underlying operating system of the Managed MongoDB Database. This function runs during regular maintenance windows, which are configurable with the Managed MongoDB Database Update (PUT /databases/mongodb/instances/{instanceId}) command. Requires read_write access to the Database. The Database must have an active status to perform this command. Note: If your database cluster is configured with a single node, you will experience downtime during this maintenance. Consider upgrading to a high availability plan to avoid any downtime due to maintenance. The database software is not updated automatically. To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. Note: New MongoDB Databases cannot currently be created.
putDatabasesMongoDBInstance	EXEC	instanceId	Update a Managed MongoDB Database. Requires read_write access to the Database. The Database must have an active status to perform this command. Updating addresses in the allow_list overwrites any existing addresses. IP addresses and ranges on this list can access the Managed Database. All other sources are blocked. If 0.0.0.0/0 is a value in this list, then all IP addresses can access the Managed Database. Entering an empty array ([]) blocks all connections (both public and private) to the Managed Database. Note: Updates to the allow_list may take a short period of time to complete, making this command inappropriate for rapid successive updates to this property. All Managed Databases include automatic patch updates, which apply security patches and updates to the underlying operating system of the Managed MongoDB Database. The maintenance window for these updates is configured with the Managed Database's updates property. If your database cluster is configured with a single node, you will experience downtime during this maintenance window when any updates occur. It's recommended that you adjust this window to match a time that will be the least disruptive for your application and users. You may also want to consider upgrading to a high availability plan to avoid any downtime due to maintenance. The database software is not updated automatically. To upgrade to a new database engine version, consider deploying a new Managed Database with your preferred version. You can then migrate your databases from the original Managed Database cluster to the new one. Note: New MongoDB Databases cannot currently be created.