@yandex-cloud/nodejs-sdk
Version:
Yandex.Cloud NodeJS SDK
1,029 lines (1,028 loc) • 3.35 MB
TypeScript
import _m0 from "protobufjs/minimal";
import { MaintenanceWindow, MaintenanceOperation } from "../../../../../yandex/cloud/mdb/mongodb/v1/maintenance";
import { TimeOfDay } from "../../../../../google/type/timeofday";
import { Mongodconfigset36, Mongocfgconfigset36, Mongosconfigset36 } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6";
import { Mongodconfigset40, Mongocfgconfigset40, Mongosconfigset40 } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0";
import { Mongodconfigset42, Mongocfgconfigset42, Mongosconfigset42 } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_2";
import { Mongodconfigset44, Mongocfgconfigset44, Mongosconfigset44 } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_4";
import { Mongodconfigset44Enterprise, Mongocfgconfigset44Enterprise, Mongosconfigset44Enterprise } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_4_enterprise";
import { Mongodconfigset50, Mongocfgconfigset50, Mongosconfigset50 } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb5_0";
import { Mongodconfigset50Enterprise, Mongocfgconfigset50Enterprise, Mongosconfigset50Enterprise } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb5_0_enterprise";
import { Mongodconfigset60, Mongocfgconfigset60, Mongosconfigset60 } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb6_0";
import { Mongodconfigset60Enterprise, Mongocfgconfigset60Enterprise, Mongosconfigset60Enterprise } from "../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb6_0_enterprise";
export declare const protobufPackage = "yandex.cloud.mdb.mongodb.v1";
/** A managed MongoDB cluster. For more information, see the [documentation](/docs/managed-mongodb/concepts). */
export interface Cluster {
$type: "yandex.cloud.mdb.mongodb.v1.Cluster";
/**
* ID of the MongoDB cluster.
* This ID is assigned by MDB at creation time.
*/
id: string;
/** ID of the folder that the MongoDB cluster belongs to. */
folderId: string;
/** Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */
createdAt?: Date;
/**
* Name of the MongoDB cluster.
* The name is unique within the folder. 1-63 characters long.
*/
name: string;
/** Description of the MongoDB cluster. 0-256 characters long. */
description: string;
/** Custom labels for the MongoDB cluster as `` key:value `` pairs. Maximum 64 per resource. */
labels: {
[key: string]: string;
};
/** Deployment environment of the MongoDB cluster. */
environment: Cluster_Environment;
/** Description of monitoring systems relevant to the MongoDB cluster. */
monitoring: Monitoring[];
/** Configuration of the MongoDB cluster. */
config?: ClusterConfig;
/** ID of the network that the cluster belongs to. */
networkId: string;
/** Aggregated cluster health. */
health: Cluster_Health;
/** Current state of the cluster. */
status: Cluster_Status;
/** Indicates current sharding status of the cluster. */
sharded: boolean;
/** Maintenance window for the cluster. */
maintenanceWindow?: MaintenanceWindow;
/** Planned maintenance operation to be started for the cluster within the nearest [maintenance_window]. */
plannedOperation?: MaintenanceOperation;
/** User security groups */
securityGroupIds: string[];
/** Deletion Protection inhibits deletion of the cluster */
deletionProtection: boolean;
}
/** Deployment environment. */
export declare enum Cluster_Environment {
ENVIRONMENT_UNSPECIFIED = 0,
/**
* PRODUCTION - Stable environment with a conservative update policy: only hotfixes
* are applied during regular maintenance.
*/
PRODUCTION = 1,
/**
* PRESTABLE - Environment with more aggressive update policy: new versions
* are rolled out irrespective of backward compatibility.
*/
PRESTABLE = 2,
UNRECOGNIZED = -1
}
export declare function cluster_EnvironmentFromJSON(object: any): Cluster_Environment;
export declare function cluster_EnvironmentToJSON(object: Cluster_Environment): string;
export declare enum Cluster_Health {
/** HEALTH_UNKNOWN - State of the cluster is unknown ([Host.health] for every host in the cluster is UNKNOWN). */
HEALTH_UNKNOWN = 0,
/** ALIVE - Cluster is alive and well ([Host.health] for every host in the cluster is ALIVE). */
ALIVE = 1,
/** DEAD - Cluster is inoperable ([Host.health] for every host in the cluster is DEAD). */
DEAD = 2,
/** DEGRADED - Cluster is working below capacity ([Host.health] for at least one host in the cluster is not ALIVE). */
DEGRADED = 3,
UNRECOGNIZED = -1
}
export declare function cluster_HealthFromJSON(object: any): Cluster_Health;
export declare function cluster_HealthToJSON(object: Cluster_Health): string;
export declare enum Cluster_Status {
/** STATUS_UNKNOWN - Cluster state is unknown. */
STATUS_UNKNOWN = 0,
/** CREATING - Cluster is being created. */
CREATING = 1,
/** RUNNING - Cluster is running normally. */
RUNNING = 2,
/** ERROR - Cluster encountered a problem and cannot operate. */
ERROR = 3,
/** UPDATING - Cluster is being updated. */
UPDATING = 4,
/** STOPPING - Cluster is stopping. */
STOPPING = 5,
/** STOPPED - Cluster stopped. */
STOPPED = 6,
/** STARTING - Cluster is starting. */
STARTING = 7,
UNRECOGNIZED = -1
}
export declare function cluster_StatusFromJSON(object: any): Cluster_Status;
export declare function cluster_StatusToJSON(object: Cluster_Status): string;
export interface Cluster_LabelsEntry {
$type: "yandex.cloud.mdb.mongodb.v1.Cluster.LabelsEntry";
key: string;
value: string;
}
/** Monitoring system. */
export interface Monitoring {
$type: "yandex.cloud.mdb.mongodb.v1.Monitoring";
/** Name of the monitoring system. */
name: string;
/** Description of the monitoring system. */
description: string;
/** Link to the monitoring system charts for the MongoDB cluster. */
link: string;
}
export interface ClusterConfig {
$type: "yandex.cloud.mdb.mongodb.v1.ClusterConfig";
/** Version of MongoDB server software. Possible values: `3.6`, `4.0`, `4.2`, `4.4`, `4.4-enterprise`, `5.0`, `5.0-enterprise`, `6.0`, `6.0-enterprise`. */
version: string;
/**
* MongoDB feature compatibility version. See usage details in [MongoDB documentation](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion/).
*
* Possible values:
* * `3.6` - persist data compatibility for version 3.6. After setting this option the data will not be compatible with 3.4 or lower.
* * `4.0` - persist data compatibility for version 4.0. After setting this option the data will not be compatible with 3.6 or lower.
* * `4.2` - persist data compatibility for version 4.2. After setting this option the data will not be compatible with 4.0 or lower.
* * `4.4` - persist data compatibility for version 4.4. After setting this option the data will not be compatible with 4.2 or lower.
* * `5.0` - persist data compatibility for version 5.0. After setting this option the data will not be compatible with 5.0 or lower.
* * `6.0` - persist data compatibility for version 6.0. After setting this option the data will not be compatible with 6.0 or lower.
*/
featureCompatibilityVersion: string;
/** Configuration and resource allocation for a MongoDB 3.6 cluster. */
mongodb36?: Mongodb36 | undefined;
/** Configuration and resource allocation for a MongoDB 4.0 cluster. */
mongodb40?: Mongodb40 | undefined;
/** Configuration and resource allocation for a MongoDB 4.2 cluster. */
mongodb42?: Mongodb42 | undefined;
/** Configuration and resource allocation for a MongoDB 4.4 cluster. */
mongodb44?: Mongodb44 | undefined;
/** Configuration and resource allocation for a MongoDB 5.0 cluster. */
mongodb50?: Mongodb50 | undefined;
/** Configuration and resource allocation for a MongoDB 6.0 cluster. */
mongodb60?: Mongodb60 | undefined;
/** Configuration and resource allocation for a MongoDB 4.4 Enterprise cluster. */
mongodb44Enterprise?: Mongodb44Enterprise | undefined;
/** Configuration and resource allocation for a MongoDB 5.0 Enterprise cluster. */
mongodb50Enterprise?: Mongodb50Enterprise | undefined;
/** Configuration and resource allocation for a MongoDB 6.0 Enterprise cluster. */
mongodb60Enterprise?: Mongodb60Enterprise | undefined;
/** Time to start the daily backup, in the UTC timezone. */
backupWindowStart?: TimeOfDay;
/** Retain period of automatically created backup in days */
backupRetainPeriodDays?: number;
/** Performance Diagnostic */
performanceDiagnostics?: PerformanceDiagnosticsConfig;
/** Access policy to DB */
access?: Access;
}
export interface Mongodb36 {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb3_6";
/** Configuration and resource allocation for mongod in a MongoDB 3.6 cluster. */
mongod?: Mongodb36_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 3.6 cluster. */
mongocfg?: Mongodb36_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 3.6 cluster. */
mongos?: Mongodb36_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 3.6 cluster. */
mongoinfra?: Mongodb36_MongoInfra;
}
export interface Mongodb36_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb3_6.Mongod";
/** Configuration for a mongod 3.6 hosts. */
config?: Mongodconfigset36;
/** Resources allocated to MongoDB hosts. */
resources?: Resources;
}
export interface Mongodb36_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb3_6.MongoCfg";
config?: Mongocfgconfigset36;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb36_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb3_6.Mongos";
config?: Mongosconfigset36;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb36_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb3_6.MongoInfra";
configMongos?: Mongosconfigset36;
configMongocfg?: Mongocfgconfigset36;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb40 {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_0";
/** Configuration and resource allocation for mongod in a MongoDB 4.0 cluster. */
mongod?: Mongodb40_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 4.0 cluster. */
mongocfg?: Mongodb40_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 4.0 cluster. */
mongos?: Mongodb40_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.0 cluster. */
mongoinfra?: Mongodb40_MongoInfra;
}
export interface Mongodb40_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_0.Mongod";
/** Configuration for mongod 4.0 hosts. */
config?: Mongodconfigset40;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb40_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_0.MongoCfg";
/** Configuration for mongocfg 4.0 hosts. */
config?: Mongocfgconfigset40;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb40_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_0.Mongos";
/** Configuration for mongos 4.0 hosts. */
config?: Mongosconfigset40;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb40_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_0.MongoInfra";
configMongos?: Mongosconfigset40;
configMongocfg?: Mongocfgconfigset40;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb42 {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_2";
/** Configuration and resource allocation for mongod in a MongoDB 4.2 cluster. */
mongod?: Mongodb42_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 4.2 cluster. */
mongocfg?: Mongodb42_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 4.2 cluster. */
mongos?: Mongodb42_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.2 cluster. */
mongoinfra?: Mongodb42_MongoInfra;
}
export interface Mongodb42_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_2.Mongod";
/** Configuration for mongod 4.2 hosts. */
config?: Mongodconfigset42;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb42_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_2.MongoCfg";
/** Configuration for mongocfg 4.2 hosts. */
config?: Mongocfgconfigset42;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb42_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_2.Mongos";
/** Configuration for mongos 4.2 hosts. */
config?: Mongosconfigset42;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb42_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_2.MongoInfra";
configMongos?: Mongosconfigset42;
configMongocfg?: Mongocfgconfigset42;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb44 {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4";
/** Configuration and resource allocation for mongod in a MongoDB 4.4 cluster. */
mongod?: Mongodb44_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 4.4 cluster. */
mongocfg?: Mongodb44_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 4.4 cluster. */
mongos?: Mongodb44_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.4 cluster. */
mongoinfra?: Mongodb44_MongoInfra;
}
export interface Mongodb44_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4.Mongod";
/** Configuration for mongod 4.4 hosts. */
config?: Mongodconfigset44;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb44_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4.MongoCfg";
/** Configuration for mongocfg 4.4 hosts. */
config?: Mongocfgconfigset44;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb44_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4.Mongos";
/** Configuration for mongos 4.4 hosts. */
config?: Mongosconfigset44;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb44_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4.MongoInfra";
configMongos?: Mongosconfigset44;
configMongocfg?: Mongocfgconfigset44;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb44Enterprise {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4_enterprise";
/** Configuration and resource allocation for mongod in a MongoDB 4.4 cluster. */
mongod?: Mongodb44Enterprise_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 4.4 cluster. */
mongocfg?: Mongodb44Enterprise_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 4.4 cluster. */
mongos?: Mongodb44Enterprise_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 4.4 cluster. */
mongoinfra?: Mongodb44Enterprise_MongoInfra;
}
export interface Mongodb44Enterprise_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4_enterprise.Mongod";
/** Configuration for mongod 4.4 hosts. */
config?: Mongodconfigset44Enterprise;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb44Enterprise_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4_enterprise.MongoCfg";
/** Configuration for mongocfg 4.4 hosts. */
config?: Mongocfgconfigset44Enterprise;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb44Enterprise_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4_enterprise.Mongos";
/** Configuration for mongos 4.4 hosts. */
config?: Mongosconfigset44Enterprise;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb44Enterprise_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb4_4_enterprise.MongoInfra";
configMongos?: Mongosconfigset44Enterprise;
configMongocfg?: Mongocfgconfigset44Enterprise;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb50 {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0";
/** Configuration and resource allocation for mongod in a MongoDB 5.0 cluster. */
mongod?: Mongodb50_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 5.0 cluster. */
mongocfg?: Mongodb50_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 5.0 cluster. */
mongos?: Mongodb50_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 5.0 cluster. */
mongoinfra?: Mongodb50_MongoInfra;
}
export interface Mongodb50_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0.Mongod";
/** Configuration for mongod 5.0 hosts. */
config?: Mongodconfigset50;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb50_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0.MongoCfg";
/** Configuration for mongocfg 5.0 hosts. */
config?: Mongocfgconfigset50;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb50_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0.Mongos";
/** Configuration for mongos 5.0 hosts. */
config?: Mongosconfigset50;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb50_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0.MongoInfra";
configMongos?: Mongosconfigset50;
configMongocfg?: Mongocfgconfigset50;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb50Enterprise {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0_enterprise";
/** Configuration and resource allocation for mongod in a MongoDB 5.0 cluster. */
mongod?: Mongodb50Enterprise_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 5.0 cluster. */
mongocfg?: Mongodb50Enterprise_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 5.0 cluster. */
mongos?: Mongodb50Enterprise_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 5.0 cluster. */
mongoinfra?: Mongodb50Enterprise_MongoInfra;
}
export interface Mongodb50Enterprise_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0_enterprise.Mongod";
/** Configuration for mongod 5.0 hosts. */
config?: Mongodconfigset50Enterprise;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb50Enterprise_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0_enterprise.MongoCfg";
/** Configuration for mongocfg 5.0 hosts. */
config?: Mongocfgconfigset50Enterprise;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb50Enterprise_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0_enterprise.Mongos";
/** Configuration for mongos 5.0 hosts. */
config?: Mongosconfigset50Enterprise;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb50Enterprise_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb5_0_enterprise.MongoInfra";
configMongos?: Mongosconfigset50Enterprise;
configMongocfg?: Mongocfgconfigset50Enterprise;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb60 {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0";
/** Configuration and resource allocation for mongod in a MongoDB 6.0 cluster. */
mongod?: Mongodb60_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 6.0 cluster. */
mongocfg?: Mongodb60_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 6.0 cluster. */
mongos?: Mongodb60_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 6.0 cluster. */
mongoinfra?: Mongodb60_MongoInfra;
}
export interface Mongodb60_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0.Mongod";
/** Configuration for mongod 6.0 hosts. */
config?: Mongodconfigset60;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb60_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0.MongoCfg";
/** Configuration for mongocfg 6.0 hosts. */
config?: Mongocfgconfigset60;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb60_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0.Mongos";
/** Configuration for mongos 6.0 hosts. */
config?: Mongosconfigset60;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb60_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0.MongoInfra";
configMongos?: Mongosconfigset60;
configMongocfg?: Mongocfgconfigset60;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Mongodb60Enterprise {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0_enterprise";
/** Configuration and resource allocation for mongod in a MongoDB 6.0 cluster. */
mongod?: Mongodb60Enterprise_Mongod;
/** Configuration and resource allocation for mongocfg in a MongoDB 6.0 cluster. */
mongocfg?: Mongodb60Enterprise_MongoCfg;
/** Configuration and resource allocation for mongos in a MongoDB 6.0 cluster. */
mongos?: Mongodb60Enterprise_Mongos;
/** Configuration and resource allocation for mongoinfra (mongos+mongocfg) in a MongoDB 6.0 cluster. */
mongoinfra?: Mongodb60Enterprise_MongoInfra;
}
export interface Mongodb60Enterprise_Mongod {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0_enterprise.Mongod";
/** Configuration for mongod 6.0 hosts. */
config?: Mongodconfigset60Enterprise;
/** Resources allocated to mongod hosts. */
resources?: Resources;
}
export interface Mongodb60Enterprise_MongoCfg {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0_enterprise.MongoCfg";
/** Configuration for mongocfg 6.0 hosts. */
config?: Mongocfgconfigset60Enterprise;
/** Resources allocated to mongocfg hosts. */
resources?: Resources;
}
export interface Mongodb60Enterprise_Mongos {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0_enterprise.Mongos";
/** Configuration for mongos 6.0 hosts. */
config?: Mongosconfigset60Enterprise;
/** Resources allocated to mongos hosts. */
resources?: Resources;
}
export interface Mongodb60Enterprise_MongoInfra {
$type: "yandex.cloud.mdb.mongodb.v1.Mongodb6_0_enterprise.MongoInfra";
configMongos?: Mongosconfigset60Enterprise;
configMongocfg?: Mongocfgconfigset60Enterprise;
/** Resources allocated to mongoinfra (mongos+mongocfg) hosts. */
resources?: Resources;
}
export interface Shard {
$type: "yandex.cloud.mdb.mongodb.v1.Shard";
/** Name of the shard. */
name: string;
/** ID of the cluster that the shard belongs to. */
clusterId: string;
}
export interface Host {
$type: "yandex.cloud.mdb.mongodb.v1.Host";
/**
* Name of the MongoDB host. The host name is assigned by MDB at creation time, and cannot be changed.
* 1-63 characters long.
*
* The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.
*/
name: string;
/** ID of the MongoDB host. The ID is assigned by MDB at creation time. */
clusterId: string;
/** ID of the availability zone where the MongoDB host resides. */
zoneId: string;
/** Resources allocated to the MongoDB host. */
resources?: Resources;
/** Role of the host in the cluster. */
role: Host_Role;
/** Status code of the aggregated health of the host. */
health: Host_Health;
/** Services provided by the host. */
services: Service[];
/** ID of the subnet that the host belongs to. */
subnetId: string;
/** Flag showing public IP assignment status to this host. */
assignPublicIp: boolean;
/** Shard which this host belongs to. */
shardName: string;
/** Host type */
type: Host_Type;
}
export declare enum Host_Type {
TYPE_UNSPECIFIED = 0,
/** MONGOD - A mongod host. */
MONGOD = 1,
/** MONGOS - A mongos host. */
MONGOS = 2,
/** MONGOCFG - A mongocfg host. */
MONGOCFG = 3,
/** MONGOINFRA - A mongoinfra (mongos+mongocfg) host. */
MONGOINFRA = 4,
UNRECOGNIZED = -1
}
export declare function host_TypeFromJSON(object: any): Host_Type;
export declare function host_TypeToJSON(object: Host_Type): string;
export declare enum Host_Role {
/** ROLE_UNKNOWN - Role of the host in the cluster is unknown. */
ROLE_UNKNOWN = 0,
/** PRIMARY - Host is the primary MongoDB server in the cluster. */
PRIMARY = 1,
/** SECONDARY - Host is a secondary MongoDB server in the cluster. */
SECONDARY = 2,
UNRECOGNIZED = -1
}
export declare function host_RoleFromJSON(object: any): Host_Role;
export declare function host_RoleToJSON(object: Host_Role): string;
export declare enum Host_Health {
/** HEALTH_UNKNOWN - Health of the host is unknown. */
HEALTH_UNKNOWN = 0,
/** ALIVE - The host is performing all its functions normally. */
ALIVE = 1,
/** DEAD - The host is inoperable, and cannot perform any of its essential functions. */
DEAD = 2,
/** DEGRADED - The host is degraded, and can perform only some of its essential functions. */
DEGRADED = 3,
UNRECOGNIZED = -1
}
export declare function host_HealthFromJSON(object: any): Host_Health;
export declare function host_HealthToJSON(object: Host_Health): string;
export interface Service {
$type: "yandex.cloud.mdb.mongodb.v1.Service";
/** Type of the service provided by the host. */
type: Service_Type;
/** Status code of server availability. */
health: Service_Health;
}
export declare enum Service_Type {
TYPE_UNSPECIFIED = 0,
/** MONGOD - The host is running a mongod daemon. */
MONGOD = 1,
/** MONGOS - The host is running a mongos daemon. */
MONGOS = 2,
/** MONGOCFG - The host is running a MongoDB config server. */
MONGOCFG = 3,
UNRECOGNIZED = -1
}
export declare function service_TypeFromJSON(object: any): Service_Type;
export declare function service_TypeToJSON(object: Service_Type): string;
export declare enum Service_Health {
/** HEALTH_UNKNOWN - Health of the server is unknown. */
HEALTH_UNKNOWN = 0,
/** ALIVE - The server is working normally. */
ALIVE = 1,
/** DEAD - The server is dead or unresponsive. */
DEAD = 2,
UNRECOGNIZED = -1
}
export declare function service_HealthFromJSON(object: any): Service_Health;
export declare function service_HealthToJSON(object: Service_Health): string;
export interface Resources {
$type: "yandex.cloud.mdb.mongodb.v1.Resources";
/**
* ID of the preset for computational resources available to a host (CPU, memory etc.).
* All available presets are listed in the [documentation](/docs/managed-mongodb/concepts/instance-types).
*/
resourcePresetId: string;
/** Volume of the storage available to a host, in bytes. */
diskSize: number;
/**
* Type of the storage environment for the host.
* Possible values:
* * network-hdd - network HDD drive,
* * network-ssd - network SSD drive,
* * local-ssd - local SSD storage.
*/
diskTypeId: string;
}
export interface Access {
$type: "yandex.cloud.mdb.mongodb.v1.Access";
/** Allow access for DataLens. */
dataLens: boolean;
/** Allow access for DataTransfer. */
dataTransfer: boolean;
}
export interface PerformanceDiagnosticsConfig {
$type: "yandex.cloud.mdb.mongodb.v1.PerformanceDiagnosticsConfig";
profilingEnabled: boolean;
}
export declare const Cluster: {
$type: "yandex.cloud.mdb.mongodb.v1.Cluster";
encode(message: Cluster, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): Cluster;
fromJSON(object: any): Cluster;
toJSON(message: Cluster): unknown;
fromPartial<I extends {
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: Cluster_Status | undefined;
config?: {
version?: string | undefined;
backupWindowStart?: {
seconds?: number | undefined;
nanos?: number | undefined;
hours?: number | undefined;
minutes?: number | undefined;
} | undefined;
access?: {
dataLens?: boolean | undefined;
dataTransfer?: boolean | undefined;
} | undefined;
featureCompatibilityVersion?: string | undefined;
mongodb36?: {
mongod?: {
config?: {
effectiveConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
collectionConfig?: {
blockCompressor?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongodconfig36_Storage_WiredTiger_CollectionConfig_Compressor | undefined;
} | undefined;
} | undefined;
journal?: {
enabled?: boolean | undefined;
commitInterval?: number | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongodconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
userConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
collectionConfig?: {
blockCompressor?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongodconfig36_Storage_WiredTiger_CollectionConfig_Compressor | undefined;
} | undefined;
} | undefined;
journal?: {
enabled?: boolean | undefined;
commitInterval?: number | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongodconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
defaultConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
collectionConfig?: {
blockCompressor?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongodconfig36_Storage_WiredTiger_CollectionConfig_Compressor | undefined;
} | undefined;
} | undefined;
journal?: {
enabled?: boolean | undefined;
commitInterval?: number | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongodconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
} | undefined;
mongocfg?: {
config?: {
effectiveConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongocfgconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
userConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongocfgconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
defaultConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongocfgconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
} | undefined;
mongos?: {
config?: {
effectiveConfig?: {
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
userConfig?: {
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
defaultConfig?: {
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
} | undefined;
mongoinfra?: {
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
configMongos?: {
effectiveConfig?: {
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
userConfig?: {
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
defaultConfig?: {
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
configMongocfg?: {
effectiveConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongocfgconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
userConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongocfgconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
defaultConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb3_6").Mongocfgconfig36_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
} | undefined;
} | undefined;
mongodb40?: {
mongod?: {
config?: {
effectiveConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
collectionConfig?: {
blockCompressor?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongodconfig40_Storage_WiredTiger_CollectionConfig_Compressor | undefined;
} | undefined;
} | undefined;
journal?: {
commitInterval?: number | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongodconfig40_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
userConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
collectionConfig?: {
blockCompressor?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongodconfig40_Storage_WiredTiger_CollectionConfig_Compressor | undefined;
} | undefined;
} | undefined;
journal?: {
commitInterval?: number | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongodconfig40_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
defaultConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
collectionConfig?: {
blockCompressor?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongodconfig40_Storage_WiredTiger_CollectionConfig_Compressor | undefined;
} | undefined;
} | undefined;
journal?: {
commitInterval?: number | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongodconfig40_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
} | undefined;
mongocfg?: {
config?: {
effectiveConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongocfgconfig40_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
userConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
operationProfiling?: {
mode?: import("../../../../../yandex/cloud/mdb/mongodb/v1/config/mongodb4_0").Mongocfgconfig40_OperationProfiling_Mode | undefined;
slowOpThreshold?: number | undefined;
} | undefined;
net?: {
maxIncomingConnections?: number | undefined;
} | undefined;
} | undefined;
defaultConfig?: {
storage?: {
wiredTiger?: {
engineConfig?: {
cacheSizeGb?: number | undefined;
} | undefined;
} | undefined;