Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Yandex

v0.10.0 published on Thursday, Nov 18, 2021 by Pulumi

MdbElasticSearchCluster

Manages a Elasticsearch cluster within the Yandex.Cloud. For more information, see the official documentation.

Create a MdbElasticSearchCluster Resource

new MdbElasticSearchCluster(name: string, args: MdbElasticSearchClusterArgs, opts?: CustomResourceOptions);
@overload
def MdbElasticSearchCluster(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            config: Optional[MdbElasticSearchClusterConfigArgs] = None,
                            deletion_protection: Optional[bool] = None,
                            description: Optional[str] = None,
                            environment: Optional[str] = None,
                            folder_id: Optional[str] = None,
                            hosts: Optional[Sequence[MdbElasticSearchClusterHostArgs]] = None,
                            labels: Optional[Mapping[str, str]] = None,
                            name: Optional[str] = None,
                            network_id: Optional[str] = None,
                            security_group_ids: Optional[Sequence[str]] = None,
                            service_account_id: Optional[str] = None)
@overload
def MdbElasticSearchCluster(resource_name: str,
                            args: MdbElasticSearchClusterArgs,
                            opts: Optional[ResourceOptions] = None)
func NewMdbElasticSearchCluster(ctx *Context, name string, args MdbElasticSearchClusterArgs, opts ...ResourceOption) (*MdbElasticSearchCluster, error)
public MdbElasticSearchCluster(string name, MdbElasticSearchClusterArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args MdbElasticSearchClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args MdbElasticSearchClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args MdbElasticSearchClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args MdbElasticSearchClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

MdbElasticSearchCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The MdbElasticSearchCluster resource accepts the following input properties:

Config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
Environment string
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
NetworkId string
ID of the network, to which the Elasticsearch cluster belongs.
DeletionProtection bool
Inhibits deletion of the cluster. Can be either true or false.
Description string
Description of the Elasticsearch cluster.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Hosts List<MdbElasticSearchClusterHostArgs>
A host of the Elasticsearch cluster. The structure is documented below.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
User defined host name.
SecurityGroupIds List<string>
A set of ids of security groups assigned to hosts of the cluster.
ServiceAccountId string
ID of the service account authorized for this cluster.
Config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
Environment string
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
NetworkId string
ID of the network, to which the Elasticsearch cluster belongs.
DeletionProtection bool
Inhibits deletion of the cluster. Can be either true or false.
Description string
Description of the Elasticsearch cluster.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Hosts []MdbElasticSearchClusterHostArgs
A host of the Elasticsearch cluster. The structure is documented below.
Labels map[string]string
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
User defined host name.
SecurityGroupIds []string
A set of ids of security groups assigned to hosts of the cluster.
ServiceAccountId string
ID of the service account authorized for this cluster.
config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
environment string
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
networkId string
ID of the network, to which the Elasticsearch cluster belongs.
deletionProtection boolean
Inhibits deletion of the cluster. Can be either true or false.
description string
Description of the Elasticsearch cluster.
folderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
hosts MdbElasticSearchClusterHostArgs[]
A host of the Elasticsearch cluster. The structure is documented below.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Elasticsearch cluster.
name string
User defined host name.
securityGroupIds string[]
A set of ids of security groups assigned to hosts of the cluster.
serviceAccountId string
ID of the service account authorized for this cluster.
config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
environment str
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
network_id str
ID of the network, to which the Elasticsearch cluster belongs.
deletion_protection bool
Inhibits deletion of the cluster. Can be either true or false.
description str
Description of the Elasticsearch cluster.
folder_id str
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
hosts Sequence[MdbElasticSearchClusterHostArgs]
A host of the Elasticsearch cluster. The structure is documented below.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Elasticsearch cluster.
name str
User defined host name.
security_group_ids Sequence[str]
A set of ids of security groups assigned to hosts of the cluster.
service_account_id str
ID of the service account authorized for this cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the MdbElasticSearchCluster resource produces the following output properties:

CreatedAt string
Creation timestamp of the key.
Health 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.
Id string
The provider-assigned unique ID for this managed resource.
Status 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.
CreatedAt string
Creation timestamp of the key.
Health 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.
Id string
The provider-assigned unique ID for this managed resource.
Status 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.
createdAt string
Creation timestamp of the key.
health 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.
id string
The provider-assigned unique ID for this managed resource.
status 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.
created_at str
Creation timestamp of the key.
health str
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.
id str
The provider-assigned unique ID for this managed resource.
status str
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.

Look up an Existing MdbElasticSearchCluster Resource

Get an existing MdbElasticSearchCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MdbElasticSearchClusterState, opts?: CustomResourceOptions): MdbElasticSearchCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[MdbElasticSearchClusterConfigArgs] = None,
        created_at: Optional[str] = None,
        deletion_protection: Optional[bool] = None,
        description: Optional[str] = None,
        environment: Optional[str] = None,
        folder_id: Optional[str] = None,
        health: Optional[str] = None,
        hosts: Optional[Sequence[MdbElasticSearchClusterHostArgs]] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        service_account_id: Optional[str] = None,
        status: Optional[str] = None) -> MdbElasticSearchCluster
func GetMdbElasticSearchCluster(ctx *Context, name string, id IDInput, state *MdbElasticSearchClusterState, opts ...ResourceOption) (*MdbElasticSearchCluster, error)
public static MdbElasticSearchCluster Get(string name, Input<string> id, MdbElasticSearchClusterState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Inhibits deletion of the cluster. Can be either true or false.
Description string
Description of the Elasticsearch cluster.
Environment string
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Health 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.
Hosts List<MdbElasticSearchClusterHostArgs>
A host of the Elasticsearch cluster. The structure is documented below.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
User defined host name.
NetworkId string
ID of the network, to which the Elasticsearch cluster belongs.
SecurityGroupIds List<string>
A set of ids of security groups assigned to hosts of the cluster.
ServiceAccountId string
ID of the service account authorized for this cluster.
Status 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.
Config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Inhibits deletion of the cluster. Can be either true or false.
Description string
Description of the Elasticsearch cluster.
Environment string
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
FolderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
Health 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.
Hosts []MdbElasticSearchClusterHostArgs
A host of the Elasticsearch cluster. The structure is documented below.
Labels map[string]string
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
User defined host name.
NetworkId string
ID of the network, to which the Elasticsearch cluster belongs.
SecurityGroupIds []string
A set of ids of security groups assigned to hosts of the cluster.
ServiceAccountId string
ID of the service account authorized for this cluster.
Status 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.
config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
createdAt string
Creation timestamp of the key.
deletionProtection boolean
Inhibits deletion of the cluster. Can be either true or false.
description string
Description of the Elasticsearch cluster.
environment string
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
folderId string
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
health 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.
hosts MdbElasticSearchClusterHostArgs[]
A host of the Elasticsearch cluster. The structure is documented below.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Elasticsearch cluster.
name string
User defined host name.
networkId string
ID of the network, to which the Elasticsearch cluster belongs.
securityGroupIds string[]
A set of ids of security groups assigned to hosts of the cluster.
serviceAccountId string
ID of the service account authorized for this cluster.
status 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.
config MdbElasticSearchClusterConfigArgs
Configuration of the Elasticsearch cluster. The structure is documented below.
created_at str
Creation timestamp of the key.
deletion_protection bool
Inhibits deletion of the cluster. Can be either true or false.
description str
Description of the Elasticsearch cluster.
environment str
Deployment environment of the Elasticsearch cluster. Can be either PRESTABLE or PRODUCTION.
folder_id str
The ID of the folder that the resource belongs to. If it is not provided, the default provider folder is used.
health str
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.
hosts Sequence[MdbElasticSearchClusterHostArgs]
A host of the Elasticsearch cluster. The structure is documented below.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Elasticsearch cluster.
name str
User defined host name.
network_id str
ID of the network, to which the Elasticsearch cluster belongs.
security_group_ids Sequence[str]
A set of ids of security groups assigned to hosts of the cluster.
service_account_id str
ID of the service account authorized for this cluster.
status str
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.

Supporting Types

MdbElasticSearchClusterConfig

AdminPassword string
Password for admin user of Elasticsearch.
DataNode MdbElasticSearchClusterConfigDataNode
Configuration for Elasticsearch data nodes subcluster. The structure is documented below.
Edition string
Edition of Elasticsearch. For more information, see the official documentation.
MasterNode MdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
Plugins List<string>
A set of Elasticsearch plugins to install.
Version string
Version of Elasticsearch.
AdminPassword string
Password for admin user of Elasticsearch.
DataNode MdbElasticSearchClusterConfigDataNode
Configuration for Elasticsearch data nodes subcluster. The structure is documented below.
Edition string
Edition of Elasticsearch. For more information, see the official documentation.
MasterNode MdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
Plugins []string
A set of Elasticsearch plugins to install.
Version string
Version of Elasticsearch.
adminPassword string
Password for admin user of Elasticsearch.
dataNode MdbElasticSearchClusterConfigDataNode
Configuration for Elasticsearch data nodes subcluster. The structure is documented below.
edition string
Edition of Elasticsearch. For more information, see the official documentation.
masterNode MdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
plugins string[]
A set of Elasticsearch plugins to install.
version string
Version of Elasticsearch.
admin_password str
Password for admin user of Elasticsearch.
data_node MdbElasticSearchClusterConfigDataNode
Configuration for Elasticsearch data nodes subcluster. The structure is documented below.
edition str
Edition of Elasticsearch. For more information, see the official documentation.
master_node MdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
plugins Sequence[str]
A set of Elasticsearch plugins to install.
version str
Version of Elasticsearch.

MdbElasticSearchClusterConfigDataNode

Resources MdbElasticSearchClusterConfigDataNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.
Resources MdbElasticSearchClusterConfigDataNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.
resources MdbElasticSearchClusterConfigDataNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.
resources MdbElasticSearchClusterConfigDataNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.

MdbElasticSearchClusterConfigDataNodeResources

DiskSize int
Volume of the storage available to a host, in gigabytes.
DiskTypeId string
Type of the storage of Elasticsearch hosts.
ResourcePresetId string
DiskSize int
Volume of the storage available to a host, in gigabytes.
DiskTypeId string
Type of the storage of Elasticsearch hosts.
ResourcePresetId string
diskSize number
Volume of the storage available to a host, in gigabytes.
diskTypeId string
Type of the storage of Elasticsearch hosts.
resourcePresetId string
disk_size int
Volume of the storage available to a host, in gigabytes.
disk_type_id str
Type of the storage of Elasticsearch hosts.
resource_preset_id str

MdbElasticSearchClusterConfigMasterNode

Resources MdbElasticSearchClusterConfigMasterNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.
Resources MdbElasticSearchClusterConfigMasterNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.
resources MdbElasticSearchClusterConfigMasterNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.
resources MdbElasticSearchClusterConfigMasterNodeResources
Resources allocated to hosts of the Elasticsearch master nodes subcluster. The structure is documented below.

MdbElasticSearchClusterConfigMasterNodeResources

DiskSize int
Volume of the storage available to a host, in gigabytes.
DiskTypeId string
Type of the storage of Elasticsearch hosts.
ResourcePresetId string
DiskSize int
Volume of the storage available to a host, in gigabytes.
DiskTypeId string
Type of the storage of Elasticsearch hosts.
ResourcePresetId string
diskSize number
Volume of the storage available to a host, in gigabytes.
diskTypeId string
Type of the storage of Elasticsearch hosts.
resourcePresetId string
disk_size int
Volume of the storage available to a host, in gigabytes.
disk_type_id str
Type of the storage of Elasticsearch hosts.
resource_preset_id str

MdbElasticSearchClusterHost

Name string
User defined host name.
Type string
The type of the host to be deployed. Can be either DATA_NODE or MASTER_NODE.
Zone string
The availability zone where the Elasticsearch host will be created. For more information see the official documentation.
AssignPublicIp bool
Sets whether the host should get a public IP address on creation. Can be either true or false.
Fqdn string
The fully qualified domain name of the host.
SubnetId string
The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
Name string
User defined host name.
Type string
The type of the host to be deployed. Can be either DATA_NODE or MASTER_NODE.
Zone string
The availability zone where the Elasticsearch host will be created. For more information see the official documentation.
AssignPublicIp bool
Sets whether the host should get a public IP address on creation. Can be either true or false.
Fqdn string
The fully qualified domain name of the host.
SubnetId string
The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
name string
User defined host name.
type string
The type of the host to be deployed. Can be either DATA_NODE or MASTER_NODE.
zone string
The availability zone where the Elasticsearch host will be created. For more information see the official documentation.
assignPublicIp boolean
Sets whether the host should get a public IP address on creation. Can be either true or false.
fqdn string
The fully qualified domain name of the host.
subnetId string
The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.
name str
User defined host name.
type str
The type of the host to be deployed. Can be either DATA_NODE or MASTER_NODE.
zone str
The availability zone where the Elasticsearch host will be created. For more information see the official documentation.
assign_public_ip bool
Sets whether the host should get a public IP address on creation. Can be either true or false.
fqdn str
The fully qualified domain name of the host.
subnet_id str
The ID of the subnet, to which the host belongs. The subnet must be a part of the network to which the cluster belongs.

Import

A cluster can be imported using the id of the resource, e.g.

 $ pulumi import yandex:index/mdbElasticSearchCluster:MdbElasticSearchCluster foo cluster_id

Package Details

Repository
https://github.com/pulumi/pulumi-yandex
License
Apache-2.0
Notes
This Pulumi package is based on the yandex Terraform Provider.