@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
219 lines (218 loc) • 8.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import { input as inputs, output as outputs } from "./types";
/**
* Manages a Elasticsearch cluster within the Yandex.Cloud. For more information, see
* [the official documentation](https://cloud.yandex.com/docs/managed-elasticsearch/concepts).
*
* ## Import
*
* A cluster can be imported using the `id` of the resource, e.g.
*
* ```sh
* $ pulumi import yandex:index/mdbElasticSearchCluster:MdbElasticSearchCluster foo cluster_id
* ```
*/
export declare class MdbElasticSearchCluster extends pulumi.CustomResource {
/**
* Get an existing MdbElasticSearchCluster resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MdbElasticSearchClusterState, opts?: pulumi.CustomResourceOptions): MdbElasticSearchCluster;
/**
* Returns true if the given object is an instance of MdbElasticSearchCluster. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MdbElasticSearchCluster;
/**
* Configuration of the Elasticsearch cluster. The structure is documented below.
*/
readonly config: pulumi.Output<outputs.MdbElasticSearchClusterConfig>;
/**
* Creation timestamp of the key.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Inhibits deletion of the cluster. Can be either `true` or `false`.
*/
readonly deletionProtection: pulumi.Output<boolean>;
/**
* Description of the Elasticsearch cluster.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Deployment environment of the Elasticsearch cluster. Can be either `PRESTABLE` or `PRODUCTION`.
*/
readonly environment: pulumi.Output<string>;
/**
* The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
*/
readonly folderId: pulumi.Output<string>;
/**
* Aggregated health of the cluster. Can be either `ALIVE`, `DEGRADED`, `DEAD` or `HEALTH_UNKNOWN`.
* For more information see `health` field of JSON representation in [the official documentation](https://cloud.yandex.com/docs/managed-elasticsearch/api-ref/Cluster/).
*/
readonly health: pulumi.Output<string>;
/**
* A host of the Elasticsearch cluster. The structure is documented below.
*/
readonly hosts: pulumi.Output<outputs.MdbElasticSearchClusterHost[]>;
/**
* A set of key/value label pairs to assign to the Elasticsearch cluster.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly maintenanceWindow: pulumi.Output<outputs.MdbElasticSearchClusterMaintenanceWindow>;
/**
* User defined host name.
*/
readonly name: pulumi.Output<string>;
/**
* ID of the network, to which the Elasticsearch cluster belongs.
*/
readonly networkId: pulumi.Output<string>;
/**
* A set of ids of security groups assigned to hosts of the cluster.
*/
readonly securityGroupIds: pulumi.Output<string[] | undefined>;
/**
* ID of the service account authorized for this cluster.
*/
readonly serviceAccountId: pulumi.Output<string | undefined>;
/**
* Status of the cluster. Can be either `CREATING`, `STARTING`, `RUNNING`, `UPDATING`, `STOPPING`, `STOPPED`, `ERROR` or `STATUS_UNKNOWN`.
* For more information see `status` field of JSON representation in [the official documentation](https://cloud.yandex.com/docs/managed-elasticsearch/api-ref/Cluster/).
*/
readonly status: pulumi.Output<string>;
/**
* Create a MdbElasticSearchCluster resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MdbElasticSearchClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MdbElasticSearchCluster resources.
*/
export interface MdbElasticSearchClusterState {
/**
* Configuration of the Elasticsearch cluster. The structure is documented below.
*/
config?: pulumi.Input<inputs.MdbElasticSearchClusterConfig>;
/**
* Creation timestamp of the key.
*/
createdAt?: pulumi.Input<string>;
/**
* Inhibits deletion of the cluster. Can be either `true` or `false`.
*/
deletionProtection?: pulumi.Input<boolean>;
/**
* Description of the Elasticsearch cluster.
*/
description?: pulumi.Input<string>;
/**
* Deployment environment of the Elasticsearch cluster. Can be either `PRESTABLE` or `PRODUCTION`.
*/
environment?: 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>;
/**
* Aggregated health of the cluster. Can be either `ALIVE`, `DEGRADED`, `DEAD` or `HEALTH_UNKNOWN`.
* For more information see `health` field of JSON representation in [the official documentation](https://cloud.yandex.com/docs/managed-elasticsearch/api-ref/Cluster/).
*/
health?: pulumi.Input<string>;
/**
* A host of the Elasticsearch cluster. The structure is documented below.
*/
hosts?: pulumi.Input<pulumi.Input<inputs.MdbElasticSearchClusterHost>[]>;
/**
* A set of key/value label pairs to assign to the Elasticsearch cluster.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
maintenanceWindow?: pulumi.Input<inputs.MdbElasticSearchClusterMaintenanceWindow>;
/**
* User defined host name.
*/
name?: pulumi.Input<string>;
/**
* ID of the network, to which the Elasticsearch cluster belongs.
*/
networkId?: 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>;
/**
* Status of the cluster. Can be either `CREATING`, `STARTING`, `RUNNING`, `UPDATING`, `STOPPING`, `STOPPED`, `ERROR` or `STATUS_UNKNOWN`.
* For more information see `status` field of JSON representation in [the official documentation](https://cloud.yandex.com/docs/managed-elasticsearch/api-ref/Cluster/).
*/
status?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MdbElasticSearchCluster resource.
*/
export interface MdbElasticSearchClusterArgs {
/**
* Configuration of the Elasticsearch cluster. The structure is documented below.
*/
config: pulumi.Input<inputs.MdbElasticSearchClusterConfig>;
/**
* Inhibits deletion of the cluster. Can be either `true` or `false`.
*/
deletionProtection?: pulumi.Input<boolean>;
/**
* Description of the Elasticsearch cluster.
*/
description?: pulumi.Input<string>;
/**
* Deployment environment of the Elasticsearch cluster. Can be either `PRESTABLE` or `PRODUCTION`.
*/
environment: 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 host of the Elasticsearch cluster. The structure is documented below.
*/
hosts?: pulumi.Input<pulumi.Input<inputs.MdbElasticSearchClusterHost>[]>;
/**
* A set of key/value label pairs to assign to the Elasticsearch cluster.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
maintenanceWindow?: pulumi.Input<inputs.MdbElasticSearchClusterMaintenanceWindow>;
/**
* User defined host name.
*/
name?: pulumi.Input<string>;
/**
* ID of the network, to which the Elasticsearch cluster belongs.
*/
networkId: 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>;
}