@pulumi/yandex/getMdbMysqlCluster.d.ts

A Pulumi package for creating and managing yandex cloud resources.

import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
 * Get information about a Yandex Managed MySQL cluster. For more information, see
 * [the official documentation](https://cloud.yandex.com/docs/managed-mysql/).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as yandex from "@pulumi/yandex";
 *
 * const foo = pulumi.output(yandex.getMdbMysqlCluster({
 *     name: "test",
 * }));
 *
 * export const networkId = foo.networkId;
 * ```
 */
export declare function getMdbMysqlCluster(args?: GetMdbMysqlClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetMdbMysqlClusterResult>;
/**
 * A collection of arguments for invoking getMdbMysqlCluster.
 */
export interface GetMdbMysqlClusterArgs {
    /**
     * Access policy to the MySQL cluster. The structure is documented below.
     */
    access?: inputs.GetMdbMysqlClusterAccess;
    /**
     * The ID of the MySQL cluster.
     */
    clusterId?: string;
    deletionProtection?: boolean;
    /**
     * Description of the MySQL cluster.
     */
    description?: string;
    /**
     * The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
     */
    folderId?: string;
    /**
     * A set of key/value label pairs to assign to the MySQL cluster.
     */
    labels?: {
        [key: string]: string;
    };
    /**
     * MySQL cluster config.
     */
    mysqlConfig?: {
        [key: string]: string;
    };
    /**
     * The name of the MySQL cluster.
     */
    name?: string;
}
/**
 * A collection of values returned by getMdbMysqlCluster.
 */
export interface GetMdbMysqlClusterResult {
    /**
     * Access policy to the MySQL cluster. The structure is documented below.
     */
    readonly access: outputs.GetMdbMysqlClusterAccess;
    readonly backupWindowStarts: outputs.GetMdbMysqlClusterBackupWindowStart[];
    readonly clusterId: string;
    /**
     * Creation timestamp of the key.
     */
    readonly createdAt: string;
    /**
     * A database of the MySQL cluster. The structure is documented below.
     */
    readonly databases: outputs.GetMdbMysqlClusterDatabase[];
    readonly deletionProtection: boolean;
    /**
     * Description of the MySQL cluster.
     */
    readonly description?: string;
    /**
     * Deployment environment of the MySQL cluster.
     */
    readonly environment: string;
    readonly folderId: string;
    /**
     * Aggregated health of the cluster.
     */
    readonly health: string;
    /**
     * A host of the MySQL cluster. The structure is documented below.
     */
    readonly hosts: outputs.GetMdbMysqlClusterHost[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * A set of key/value label pairs to assign to the MySQL cluster.
     */
    readonly labels?: {
        [key: string]: string;
    };
    /**
     * Maintenance window settings of the MySQL cluster. The structure is documented below.
     */
    readonly maintenanceWindows: outputs.GetMdbMysqlClusterMaintenanceWindow[];
    /**
     * MySQL cluster config.
     */
    readonly mysqlConfig: {
        [key: string]: string;
    };
    /**
     * The name of the database.
     */
    readonly name: string;
    /**
     * ID of the network, to which the MySQL cluster belongs.
     */
    readonly networkId: string;
    /**
     * Resources allocated to hosts of the MySQL cluster. The structure is documented below.
     */
    readonly resources: outputs.GetMdbMysqlClusterResource[];
    /**
     * A set of ids of security groups assigned to hosts of the cluster.
     */
    readonly securityGroupIds: string[];
    /**
     * Status of the cluster.
     */
    readonly status: string;
    /**
     * A user of the MySQL cluster. The structure is documented below.
     */
    readonly users: outputs.GetMdbMysqlClusterUser[];
    /**
     * Version of the MySQL cluster.
     */
    readonly version: string;
}
export declare function getMdbMysqlClusterOutput(args?: GetMdbMysqlClusterOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMdbMysqlClusterResult>;
/**
 * A collection of arguments for invoking getMdbMysqlCluster.
 */
export interface GetMdbMysqlClusterOutputArgs {
    /**
     * Access policy to the MySQL cluster. The structure is documented below.
     */
    access?: pulumi.Input<inputs.GetMdbMysqlClusterAccessArgs>;
    /**
     * The ID of the MySQL cluster.
     */
    clusterId?: pulumi.Input<string>;
    deletionProtection?: pulumi.Input<boolean>;
    /**
     * Description of the MySQL cluster.
     */
    description?: pulumi.Input<string>;
    /**
     * The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
     */
    folderId?: pulumi.Input<string>;
    /**
     * A set of key/value label pairs to assign to the MySQL cluster.
     */
    labels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * MySQL cluster config.
     */
    mysqlConfig?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The name of the MySQL cluster.
     */
    name?: pulumi.Input<string>;
}