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

Yandex

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

getMdbElasticSearchCluster

Get information about a Yandex Managed Elasticsearch cluster. For more information, see the official documentation.

Example Usage

using Pulumi;
using Yandex = Pulumi.Yandex;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Yandex.GetMdbElasticSearchCluster.InvokeAsync(new Yandex.GetMdbElasticSearchClusterArgs
        {
            Name = "test",
        }));
        this.NetworkId = foo.Apply(foo => foo.NetworkId);
    }

    [Output("networkId")]
    public Output<string> NetworkId { get; set; }
}
package main

import (
	"github.com/pulumi/pulumi-yandex/sdk/go/yandex"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "test"
		foo, err := yandex.LookupMdbElasticSearchCluster(ctx, &GetMdbElasticSearchClusterArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("networkId", foo.NetworkId)
		return nil
	})
}
import pulumi
import pulumi_yandex as yandex

foo = yandex.get_mdb_elastic_search_cluster(name="test")
pulumi.export("networkId", foo.network_id)
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;

Using getMdbElasticSearchCluster

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMdbElasticSearchCluster(args: GetMdbElasticSearchClusterArgs, opts?: InvokeOptions): Promise<GetMdbElasticSearchClusterResult>
function getMdbElasticSearchClusterOutput(args: GetMdbElasticSearchClusterOutputArgs, opts?: InvokeOptions): Output<GetMdbElasticSearchClusterResult>
def get_mdb_elastic_search_cluster(cluster_id: Optional[str] = None,
                                   deletion_protection: Optional[bool] = None,
                                   description: Optional[str] = None,
                                   folder_id: Optional[str] = None,
                                   labels: Optional[Mapping[str, str]] = None,
                                   name: Optional[str] = None,
                                   security_group_ids: Optional[Sequence[str]] = None,
                                   service_account_id: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetMdbElasticSearchClusterResult
def get_mdb_elastic_search_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
                                   deletion_protection: Optional[pulumi.Input[bool]] = None,
                                   description: Optional[pulumi.Input[str]] = None,
                                   folder_id: Optional[pulumi.Input[str]] = None,
                                   labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                   name: Optional[pulumi.Input[str]] = None,
                                   security_group_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                   service_account_id: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetMdbElasticSearchClusterResult]
func LookupMdbElasticSearchCluster(ctx *Context, args *LookupMdbElasticSearchClusterArgs, opts ...InvokeOption) (*LookupMdbElasticSearchClusterResult, error)
func LookupMdbElasticSearchClusterOutput(ctx *Context, args *LookupMdbElasticSearchClusterOutputArgs, opts ...InvokeOption) LookupMdbElasticSearchClusterResultOutput

> Note: This function is named LookupMdbElasticSearchCluster in the Go SDK.

public static class GetMdbElasticSearchCluster 
{
    public static Task<GetMdbElasticSearchClusterResult> InvokeAsync(GetMdbElasticSearchClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetMdbElasticSearchClusterResult> Invoke(GetMdbElasticSearchClusterInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ClusterId string
The ID of the Elasticsearch cluster.
DeletionProtection bool
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.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
The name of the Elasticsearch cluster.
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.
ClusterId string
The ID of the Elasticsearch cluster.
DeletionProtection bool
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.
Labels map[string]string
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
The name of the Elasticsearch cluster.
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.
clusterId string
The ID of the Elasticsearch cluster.
deletionProtection boolean
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.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Elasticsearch cluster.
name string
The name of the Elasticsearch cluster.
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.
cluster_id str
The ID of the Elasticsearch cluster.
deletion_protection bool
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.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Elasticsearch cluster.
name str
The name of the Elasticsearch cluster.
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.

getMdbElasticSearchCluster Result

The following output properties are available:

ClusterId string
Config GetMdbElasticSearchClusterConfig
Configuration of the Elasticsearch cluster. The structure is documented below.
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Description string
Description of the Elasticsearch cluster.
Environment string
Deployment environment of the Elasticsearch cluster.
FolderId string
Health string
Aggregated health of the cluster.
Hosts List<GetMdbElasticSearchClusterHost>
A host of the Elasticsearch cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, string>
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
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.
ClusterId string
Config GetMdbElasticSearchClusterConfig
Configuration of the Elasticsearch cluster. The structure is documented below.
CreatedAt string
Creation timestamp of the key.
DeletionProtection bool
Description string
Description of the Elasticsearch cluster.
Environment string
Deployment environment of the Elasticsearch cluster.
FolderId string
Health string
Aggregated health of the cluster.
Hosts []GetMdbElasticSearchClusterHost
A host of the Elasticsearch cluster. The structure is documented below.
Id string
The provider-assigned unique ID for this managed resource.
Labels map[string]string
A set of key/value label pairs to assign to the Elasticsearch cluster.
Name string
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.
clusterId string
config GetMdbElasticSearchClusterConfig
Configuration of the Elasticsearch cluster. The structure is documented below.
createdAt string
Creation timestamp of the key.
deletionProtection boolean
description string
Description of the Elasticsearch cluster.
environment string
Deployment environment of the Elasticsearch cluster.
folderId string
health string
Aggregated health of the cluster.
hosts GetMdbElasticSearchClusterHost[]
A host of the Elasticsearch cluster. The structure is documented below.
id string
The provider-assigned unique ID for this managed resource.
labels {[key: string]: string}
A set of key/value label pairs to assign to the Elasticsearch cluster.
name string
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.
cluster_id str
config GetMdbElasticSearchClusterConfig
Configuration of the Elasticsearch cluster. The structure is documented below.
created_at str
Creation timestamp of the key.
deletion_protection bool
description str
Description of the Elasticsearch cluster.
environment str
Deployment environment of the Elasticsearch cluster.
folder_id str
health str
Aggregated health of the cluster.
hosts Sequence[GetMdbElasticSearchClusterHost]
A host of the Elasticsearch cluster. The structure is documented below.
id str
The provider-assigned unique ID for this managed resource.
labels Mapping[str, str]
A set of key/value label pairs to assign to the Elasticsearch cluster.
name str
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.

Supporting Types

GetMdbElasticSearchClusterConfig

AdminPassword string
DataNode GetMdbElasticSearchClusterConfigDataNode
Configuration for Elasticsearch data nodes subcluster. The structure is documented below.
Edition string
Edition of Elasticsearch. For more information, see the official documentation.
MasterNode GetMdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
Plugins List<string>
A set of requested Elasticsearch plugins.
Version string
Version of Elasticsearch.
AdminPassword string
DataNode GetMdbElasticSearchClusterConfigDataNode
Configuration for Elasticsearch data nodes subcluster. The structure is documented below.
Edition string
Edition of Elasticsearch. For more information, see the official documentation.
MasterNode GetMdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
Plugins []string
A set of requested Elasticsearch plugins.
Version string
Version of Elasticsearch.
adminPassword string
dataNode GetMdbElasticSearchClusterConfigDataNode
Configuration for Elasticsearch data nodes subcluster. The structure is documented below.
edition string
Edition of Elasticsearch. For more information, see the official documentation.
masterNode GetMdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
plugins string[]
A set of requested Elasticsearch plugins.
version string
Version of Elasticsearch.
admin_password str
data_node GetMdbElasticSearchClusterConfigDataNode
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 GetMdbElasticSearchClusterConfigMasterNode
Configuration for Elasticsearch master nodes subcluster. The structure is documented below.
plugins Sequence[str]
A set of requested Elasticsearch plugins.
version str
Version of Elasticsearch.

GetMdbElasticSearchClusterConfigDataNode

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

GetMdbElasticSearchClusterConfigDataNodeResources

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

GetMdbElasticSearchClusterConfigMasterNode

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

GetMdbElasticSearchClusterConfigMasterNodeResources

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

GetMdbElasticSearchClusterHost

AssignPublicIp bool
Sets whether the host should get a public IP address on creation.
Fqdn string
The fully qualified domain name of the host.
Name string
The name of the Elasticsearch cluster.
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.
Type string
The type of the host to be deployed. For more information, see the official documentation.
Zone string
The availability zone where the Elasticsearch host will be created.
AssignPublicIp bool
Sets whether the host should get a public IP address on creation.
Fqdn string
The fully qualified domain name of the host.
Name string
The name of the Elasticsearch cluster.
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.
Type string
The type of the host to be deployed. For more information, see the official documentation.
Zone string
The availability zone where the Elasticsearch host will be created.
assignPublicIp boolean
Sets whether the host should get a public IP address on creation.
fqdn string
The fully qualified domain name of the host.
name string
The name of the Elasticsearch cluster.
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.
type string
The type of the host to be deployed. For more information, see the official documentation.
zone string
The availability zone where the Elasticsearch host will be created.
assign_public_ip bool
Sets whether the host should get a public IP address on creation.
fqdn str
The fully qualified domain name of the host.
name str
The name of the Elasticsearch cluster.
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.
type str
The type of the host to be deployed. For more information, see the official documentation.
zone str
The availability zone where the Elasticsearch host will be created.

Package Details

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