@pulumiverse/scaleway/mongodb/getInstance.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Gets information about a MongoDB® Instance.
 *
 * For further information refer to the Managed Databases for MongoDB® [API documentation](https://developers.scaleway.com/en/products/mongodb/api/)
 */
export declare function getInstance(args?: GetInstanceArgs, opts?: pulumi.InvokeOptions): Promise<GetInstanceResult>;
/**
 * A collection of arguments for invoking getInstance.
 */
export interface GetInstanceArgs {
    /**
     * The MongoDB® instance ID.
     *
     * > **Note** You must specify at least one: `name` or `instanceId`.
     */
    instanceId?: string;
    /**
     * The name of the MongoDB® instance.
     */
    name?: string;
    /**
     * The ID of the project the MongoDB® instance is in. Can be used to filter instances when using `name`.
     */
    projectId?: string;
    /**
     * `region`) The region in which the MongoDB® Instance exists.
     */
    region?: string;
}
/**
 * A collection of values returned by getInstance.
 */
export interface GetInstanceResult {
    /**
     * The date and time the MongoDB® instance was created.
     */
    readonly createdAt: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly instanceId?: string;
    readonly isSnapshotScheduleEnabled: boolean;
    /**
     * The name of the MongoDB® instance.
     */
    readonly name?: string;
    /**
     * The number of nodes in the MongoDB® cluster.
     */
    readonly nodeNumber: number;
    /**
     * The type of MongoDB® node.
     */
    readonly nodeType: string;
    readonly password: string;
    readonly passwordWo: string;
    readonly passwordWoVersion: number;
    readonly privateIps: outputs.mongodb.GetInstancePrivateIp[];
    readonly privateNetworks: outputs.mongodb.GetInstancePrivateNetwork[];
    /**
     * The ID of the project the instance belongs to.
     */
    readonly projectId?: string;
    /**
     * The details of the public network configuration, if applicable.
     */
    readonly publicNetworks: outputs.mongodb.GetInstancePublicNetwork[];
    readonly region?: string;
    readonly settings: {
        [key: string]: string;
    };
    readonly snapshotId: string;
    readonly snapshotScheduleFrequencyHours: number;
    readonly snapshotScheduleRetentionDays: number;
    /**
     * A list of tags attached to the MongoDB® instance.
     */
    readonly tags: string[];
    readonly tlsCertificate: string;
    readonly updatedAt: string;
    readonly userName: string;
    /**
     * The version of MongoDB® running on the instance.
     */
    readonly version: string;
    /**
     * The size of the attached volume, in GB.
     */
    readonly volumeSizeInGb: number;
    /**
     * The type of volume attached to the MongoDB® instance.
     */
    readonly volumeType: string;
}
/**
 * Gets information about a MongoDB® Instance.
 *
 * For further information refer to the Managed Databases for MongoDB® [API documentation](https://developers.scaleway.com/en/products/mongodb/api/)
 */
export declare function getInstanceOutput(args?: GetInstanceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetInstanceResult>;
/**
 * A collection of arguments for invoking getInstance.
 */
export interface GetInstanceOutputArgs {
    /**
     * The MongoDB® instance ID.
     *
     * > **Note** You must specify at least one: `name` or `instanceId`.
     */
    instanceId?: pulumi.Input<string | undefined>;
    /**
     * The name of the MongoDB® instance.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * The ID of the project the MongoDB® instance is in. Can be used to filter instances when using `name`.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * `region`) The region in which the MongoDB® Instance exists.
     */
    region?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getInstance.d.ts.map