@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
151 lines (150 loc) • 4.42 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "./types";
/**
* Get information about a Yandex Managed SQLServer cluster. For more information, see
* [the official documentation](https://cloud.yandex.com/docs/managed-sqlserver/).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const foo = pulumi.output(yandex.getMdbSqlserverCluster({
* name: "test",
* }));
*
* export const networkId = foo.networkId;
* ```
*/
export declare function getMdbSqlserverCluster(args?: GetMdbSqlserverClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetMdbSqlserverClusterResult>;
/**
* A collection of arguments for invoking getMdbSqlserverCluster.
*/
export interface GetMdbSqlserverClusterArgs {
/**
* The ID of the SQLServer cluster.
*/
clusterId?: string;
deletionProtection?: boolean;
/**
* The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
*/
folderId?: string;
/**
* The name of the SQLServer cluster.
*/
name?: string;
/**
* SQLServer cluster config.
*/
sqlserverConfig?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getMdbSqlserverCluster.
*/
export interface GetMdbSqlserverClusterResult {
readonly backupWindowStarts: outputs.GetMdbSqlserverClusterBackupWindowStart[];
readonly clusterId: string;
/**
* Creation timestamp of the key.
*/
readonly createdAt: string;
/**
* A database of the SQLServer cluster. The structure is documented below.
*/
readonly databases: outputs.GetMdbSqlserverClusterDatabase[];
readonly deletionProtection: boolean;
/**
* Description of the SQLServer cluster.
*/
readonly description: string;
/**
* Deployment environment of the SQLServer cluster.
*/
readonly environment: string;
readonly folderId: string;
/**
* Aggregated health of the cluster.
*/
readonly health: string;
/**
* A list of IDs of the host groups hosting VMs of the cluster.
*/
readonly hostGroupIds: string[];
/**
* A host of the SQLServer cluster. The structure is documented below.
*/
readonly hosts: outputs.GetMdbSqlserverClusterHost[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* A set of key/value label pairs to assign to the SQLServer cluster.
*/
readonly labels: {
[key: string]: string;
};
/**
* The name of the database.
*/
readonly name: string;
/**
* ID of the network, to which the SQLServer cluster belongs.
*/
readonly networkId: string;
/**
* Resources allocated to hosts of the SQLServer cluster. The structure is documented below.
*/
readonly resources: outputs.GetMdbSqlserverClusterResource[];
/**
* A set of ids of security groups assigned to hosts of the cluster.
*/
readonly securityGroupIds: string[];
/**
* SQLServer cluster config.
*/
readonly sqlserverConfig: {
[key: string]: string;
};
/**
* Status of the cluster.
*/
readonly status: string;
/**
* A user of the SQLServer cluster. The structure is documented below.
*/
readonly users: outputs.GetMdbSqlserverClusterUser[];
/**
* Version of the SQLServer cluster.
*/
readonly version: string;
}
export declare function getMdbSqlserverClusterOutput(args?: GetMdbSqlserverClusterOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMdbSqlserverClusterResult>;
/**
* A collection of arguments for invoking getMdbSqlserverCluster.
*/
export interface GetMdbSqlserverClusterOutputArgs {
/**
* The ID of the SQLServer cluster.
*/
clusterId?: pulumi.Input<string>;
deletionProtection?: pulumi.Input<boolean>;
/**
* 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>;
/**
* The name of the SQLServer cluster.
*/
name?: pulumi.Input<string>;
/**
* SQLServer cluster config.
*/
sqlserverConfig?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}