@pulumi/yandex/getMdbMongodbCluster.d.ts

A Pulumi package for creating and managing yandex cloud resources.

import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "./types";
/**
 * Get information about a Yandex Managed MongoDB cluster. For more information, see
 * [the official documentation](https://cloud.yandex.com/docs/managed-mongodb/concepts).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as yandex from "@pulumi/yandex";
 *
 * const foo = pulumi.output(yandex.getMdbMongodbCluster({
 *     name: "test",
 * }));
 *
 * export const networkId = foo.networkId;
 * ```
 */
export declare function getMdbMongodbCluster(args?: GetMdbMongodbClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetMdbMongodbClusterResult>;
/**
 * A collection of arguments for invoking getMdbMongodbCluster.
 */
export interface GetMdbMongodbClusterArgs {
    /**
     * The ID of the MongoDB cluster.
     */
    clusterId?: string;
    deletionProtection?: boolean;
    /**
     * Folder that the resource belongs to. If value is omitted, the default provider folder is used.
     */
    folderId?: string;
    /**
     * The name of the MongoDB cluster.
     */
    name?: string;
}
/**
 * A collection of values returned by getMdbMongodbCluster.
 */
export interface GetMdbMongodbClusterResult {
    /**
     * Configuration of the MongoDB cluster. The structure is documented below.
     */
    readonly clusterConfigs: outputs.GetMdbMongodbClusterClusterConfig[];
    readonly clusterId: string;
    /**
     * Creation timestamp of the key.
     */
    readonly createdAt: string;
    /**
     * A database of the MongoDB cluster. The structure is documented below.
     */
    readonly databases: outputs.GetMdbMongodbClusterDatabase[];
    readonly deletionProtection: boolean;
    /**
     * Description of the MongoDB cluster.
     */
    readonly description: string;
    /**
     * Deployment environment of the MongoDB cluster.
     */
    readonly environment: string;
    readonly folderId: string;
    /**
     * The health of the host.
     */
    readonly health: string;
    /**
     * A host of the MongoDB cluster. The structure is documented below.
     */
    readonly hosts: outputs.GetMdbMongodbClusterHost[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * A set of key/value label pairs to assign to the MongoDB cluster.
     */
    readonly labels: {
        [key: string]: string;
    };
    readonly maintenanceWindows: outputs.GetMdbMongodbClusterMaintenanceWindow[];
    /**
     * The name of the database.
     */
    readonly name: string;
    /**
     * ID of the network, to which the MongoDB cluster belongs.
     */
    readonly networkId: string;
    /**
     * Resources allocated to hosts of the MongoDB cluster. The structure is documented below.
     */
    readonly resources: outputs.GetMdbMongodbClusterResource[];
    /**
     * A set of ids of security groups assigned to hosts of the cluster.
     */
    readonly securityGroupIds: string[];
    /**
     * MongoDB Cluster mode enabled/disabled.
     */
    readonly sharded: boolean;
    /**
     * Status of the cluster.
     */
    readonly status: string;
    /**
     * A user of the MongoDB cluster. The structure is documented below.
     */
    readonly users: outputs.GetMdbMongodbClusterUser[];
}
export declare function getMdbMongodbClusterOutput(args?: GetMdbMongodbClusterOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMdbMongodbClusterResult>;
/**
 * A collection of arguments for invoking getMdbMongodbCluster.
 */
export interface GetMdbMongodbClusterOutputArgs {
    /**
     * The ID of the MongoDB cluster.
     */
    clusterId?: pulumi.Input<string>;
    deletionProtection?: pulumi.Input<boolean>;
    /**
     * Folder that the resource belongs to. If value is omitted, the default provider folder is used.
     */
    folderId?: pulumi.Input<string>;
    /**
     * The name of the MongoDB cluster.
     */
    name?: pulumi.Input<string>;
}