@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
154 lines (153 loc) • 4.72 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { output as outputs } from "./types";
/**
* Get information about a Yandex Managed Elasticsearch cluster. For more information, see
* [the official documentation](https://cloud.yandex.com/docs/managed-elasticsearch/concepts).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const foo = pulumi.output(yandex.getMdbElasticSearchCluster({
* name: "test",
* }));
*
* export const networkId = foo.networkId;
* ```
*/
export declare function getMdbElasticSearchCluster(args?: GetMdbElasticSearchClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetMdbElasticSearchClusterResult>;
/**
* A collection of arguments for invoking getMdbElasticSearchCluster.
*/
export interface GetMdbElasticSearchClusterArgs {
/**
* The ID of the Elasticsearch cluster.
*/
clusterId?: string;
deletionProtection?: boolean;
/**
* Description of the Elasticsearch 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 Elasticsearch cluster.
*/
labels?: {
[key: string]: string;
};
/**
* The name of the Elasticsearch cluster.
*/
name?: string;
/**
* A set of ids of security groups assigned to hosts of the cluster.
*/
securityGroupIds?: string[];
/**
* ID of the service account authorized for this cluster.
*/
serviceAccountId?: string;
}
/**
* A collection of values returned by getMdbElasticSearchCluster.
*/
export interface GetMdbElasticSearchClusterResult {
readonly clusterId: string;
/**
* Configuration of the Elasticsearch cluster. The structure is documented below.
*/
readonly configs: outputs.GetMdbElasticSearchClusterConfig[];
/**
* Creation timestamp of the key.
*/
readonly createdAt: string;
readonly deletionProtection: boolean;
/**
* Description of the Elasticsearch cluster.
*/
readonly description: string;
/**
* Deployment environment of the Elasticsearch cluster.
*/
readonly environment: string;
readonly folderId: string;
/**
* Aggregated health of the cluster.
*/
readonly health: string;
/**
* A host of the Elasticsearch cluster. The structure is documented below.
*/
readonly hosts: outputs.GetMdbElasticSearchClusterHost[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* A set of key/value label pairs to assign to the Elasticsearch cluster.
*/
readonly labels: {
[key: string]: string;
};
readonly maintenanceWindows: outputs.GetMdbElasticSearchClusterMaintenanceWindow[];
readonly name: string;
/**
* ID of the network, to which the Elasticsearch cluster belongs.
*/
readonly networkId: string;
/**
* A set of ids of security groups assigned to hosts of the cluster.
*/
readonly securityGroupIds: string[];
/**
* ID of the service account authorized for this cluster.
*/
readonly serviceAccountId: string;
/**
* Status of the cluster.
*/
readonly status: string;
}
export declare function getMdbElasticSearchClusterOutput(args?: GetMdbElasticSearchClusterOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMdbElasticSearchClusterResult>;
/**
* A collection of arguments for invoking getMdbElasticSearchCluster.
*/
export interface GetMdbElasticSearchClusterOutputArgs {
/**
* The ID of the Elasticsearch cluster.
*/
clusterId?: pulumi.Input<string>;
deletionProtection?: pulumi.Input<boolean>;
/**
* Description of the Elasticsearch 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 Elasticsearch cluster.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the Elasticsearch cluster.
*/
name?: pulumi.Input<string>;
/**
* A set of ids of security groups assigned to hosts of the cluster.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* ID of the service account authorized for this cluster.
*/
serviceAccountId?: pulumi.Input<string>;
}