Managed MongoDB Database View

{
  "type": "object",
  "description": "Managed MongoDB Databases object.",
  "properties": {
    "allow_list": {
      "type": "array",
      "description": "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.\n\nBy default, this is an empty array (`[]`), which blocks all connections (both public and private) to the Managed Database.\n\nIf `0.0.0.0/0` is a value in this list, then all IP addresses can access the Managed Database.\n",
      "items": {
        "type": "string",
        "format": "ipv4/prefix_length"
      }
    },
    "cluster_size": {
      "type": "integer",
      "description": "The number of Linode Instance nodes deployed to the Managed Database.\n\nChoosing 3 nodes creates a high availability cluster consisting of 1 primary node and 2 replica nodes.\n",
      "enum": [
        1,
        3
      ]
    },
    "compression_type": {
      "type": "string",
      "description": "The type of data compression for this Database.\n\nSnappy has a lower comparative compression ratio and resource consumption rate.\n\nZlip has a higher comparative compression ratio and resource consumption rate.\n",
      "enum": [
        "none",
        "snappy",
        "zlip"
      ]
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "When this Managed Database was created."
    },
    "encrypted": {
      "type": "boolean",
      "description": "Whether the Managed Databases is encrypted."
    },
    "engine": {
      "type": "string",
      "description": "The Managed Database engine type."
    },
    "hosts": {
      "type": "object",
      "description": "The primary and secondary hosts for the Managed Database. These are assigned after provisioning is complete.",
      "properties": {
        "primary": {
          "type": "string",
          "description": "The primary host for the Managed Database."
        },
        "secondary": {
          "type": "string",
          "description": "The secondary/private network host for the Managed Database.\n\nA private network host and a private IP can only be used to access a Database Cluster from Linodes in the same data center and will not incur transfer costs.\n\n**Note**: The secondary hostname is publicly viewable and accessible.\n"
        }
      }
    },
    "id": {
      "type": "integer",
      "description": "A unique ID that can be used to identify and reference the Managed Database."
    },
    "label": {
      "type": "string",
      "description": "A unique, user-defined string referring to the Managed Database."
    },
    "peers": {
      "type": "array",
      "description": "An array of peer addresses for this Database.\n",
      "items": {
        "type": "string",
        "description": "The peer address of a Managed MongoDB Database cluster node. Each node in a cluster has its own unique peer address.\n"
      }
    },
    "port": {
      "type": "integer",
      "description": "The access port for this Managed Database."
    },
    "region": {
      "type": "string",
      "description": "The [Region](/docs/api/regions/) ID for the Managed Database."
    },
    "replica_set": {
      "type": "string",
      "description": "Label for configuring a MongoDB [replica set](https://www.mongodb.com/docs/manual/replication/). Choose the same label on multiple Databases to include them in the same replica set.\n\nIf `null`, the Database is not included in any replica set.\n"
    },
    "ssl_connection": {
      "type": "boolean",
      "description": "Whether to require SSL credentials to establish a connection to the Managed Database.\n\nUse the **Managed MongoDB Database Credentials View** ([GET /databases/mongodb/instances/{instanceId}/credentials](/docs/api/databases/#managed-mongodb-database-credentials-view)) command for access information.\n"
    },
    "status": {
      "type": "string",
      "description": "The operating status of the Managed Database.",
      "enum": [
        "provisioning",
        "active",
        "suspending",
        "suspended",
        "resuming",
        "restoring",
        "failed",
        "degraded",
        "updating",
        "backing_up"
      ]
    },
    "storage_engine": {
      "type": "string",
      "description": "The type of storage engine for this Database.\n\n**Note:** MMAPV1 is not available for MongoDB versions 4.0 and above.\n",
      "enum": [
        "mmapv1",
        "wiredtiger"
      ]
    },
    "type": {
      "type": "string",
      "description": "The Linode Instance type used by the Managed Database for its nodes."
    },
    "updated": {
      "type": "string",
      "format": "date-time",
      "description": "When this Managed Database was last updated."
    },
    "updates": {
      "type": "object",
      "description": "Configuration settings for automated patch update maintenance for the Managed Database.",
      "properties": {
        "day_of_week": {
          "type": "integer",
          "description": "The day to perform maintenance. 1=Monday, 2=Tuesday, etc."
        },
        "duration": {
          "type": "integer",
          "description": "The maximum maintenance window time in hours."
        },
        "frequency": {
          "type": "string",
          "description": "Whether maintenance occurs on a weekly or monthly basis.",
          "enum": [
            "weekly",
            "monthly"
          ]
        },
        "hour_of_day": {
          "type": "integer",
          "description": "The hour to begin maintenance based in UTC time."
        },
        "week_of_month": {
          "type": "integer",
          "description": "The week of the month to perform `monthly` frequency updates. Defaults to `null`.\n\n* Required for `monthly` frequency updates.\n\n* Must be `null` for `weekly` frequency updates.\n"
        }
      }
    },
    "version": {
      "type": "string",
      "description": "The Managed Database engine version."
    }
  }
}