elasticstack.getElasticsearchInfo

elasticstack 0.14.5, Apr 23 26

Viewing docs for elasticstack 0.14.5
published on Thursday, Apr 23, 2026 by elastic

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";

const clusterInfo = elasticstack.getElasticsearchInfo({});

import pulumi
import pulumi_elasticstack as elasticstack

cluster_info = elasticstack.get_elasticsearch_info()

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := elasticstack.GetElasticsearchInfo(ctx, &elasticstack.GetElasticsearchInfoArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var clusterInfo = Elasticstack.GetElasticsearchInfo.Invoke();

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetElasticsearchInfoArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var clusterInfo = ElasticstackFunctions.getElasticsearchInfo(GetElasticsearchInfoArgs.builder()
            .build());

    }
}

variables:
  clusterInfo:
    fn::invoke:
      function: elasticstack:getElasticsearchInfo
      arguments: {}

Using getElasticsearchInfo

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 getElasticsearchInfo(args: GetElasticsearchInfoArgs, opts?: InvokeOptions): Promise<GetElasticsearchInfoResult>
function getElasticsearchInfoOutput(args: GetElasticsearchInfoOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchInfoResult>

def get_elasticsearch_info(elasticsearch_connection: Optional[GetElasticsearchInfoElasticsearchConnection] = None,
                           id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetElasticsearchInfoResult
def get_elasticsearch_info_output(elasticsearch_connection: pulumi.Input[Optional[GetElasticsearchInfoElasticsearchConnectionArgs]] = None,
                           id: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchInfoResult]

func GetElasticsearchInfo(ctx *Context, args *GetElasticsearchInfoArgs, opts ...InvokeOption) (*GetElasticsearchInfoResult, error)
func GetElasticsearchInfoOutput(ctx *Context, args *GetElasticsearchInfoOutputArgs, opts ...InvokeOption) GetElasticsearchInfoResultOutput

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

public static class GetElasticsearchInfo 
{
    public static Task<GetElasticsearchInfoResult> InvokeAsync(GetElasticsearchInfoArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchInfoResult> Invoke(GetElasticsearchInfoInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetElasticsearchInfoResult> getElasticsearchInfo(GetElasticsearchInfoArgs args, InvokeOptions options)
public static Output<GetElasticsearchInfoResult> getElasticsearchInfo(GetElasticsearchInfoArgs args, InvokeOptions options)

fn::invoke:
  function: elasticstack:index/getElasticsearchInfo:getElasticsearchInfo
  arguments:
    # arguments dictionary

The following arguments are supported:

ElasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.
Id string: The ID of this resource.

ElasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.
Id string: The ID of this resource.

elasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.
id String: The ID of this resource.

elasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.
id string: The ID of this resource.

elasticsearch_connection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.
id str: The ID of this resource.

elasticsearchConnection Property Map: Elasticsearch connection configuration block.
id String: The ID of this resource.

getElasticsearchInfo Result

The following output properties are available:

ClusterName string: Name of the cluster, based on the Cluster name setting setting.
ClusterUuid string: Unique identifier for the cluster.
Id string: The ID of this resource.
Name string: Name of the node.
Tagline string: Elasticsearh tag line.
Versions List<GetElasticsearchInfoVersion>: Contains statistics about the number of nodes selected by the request's node filters.
ElasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.

ClusterName string: Name of the cluster, based on the Cluster name setting setting.
ClusterUuid string: Unique identifier for the cluster.
Id string: The ID of this resource.
Name string: Name of the node.
Tagline string: Elasticsearh tag line.
Versions []GetElasticsearchInfoVersion: Contains statistics about the number of nodes selected by the request's node filters.
ElasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.

clusterName String: Name of the cluster, based on the Cluster name setting setting.
clusterUuid String: Unique identifier for the cluster.
id String: The ID of this resource.
name String: Name of the node.
tagline String: Elasticsearh tag line.
versions List<GetElasticsearchInfoVersion>: Contains statistics about the number of nodes selected by the request's node filters.
elasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.

clusterName string: Name of the cluster, based on the Cluster name setting setting.
clusterUuid string: Unique identifier for the cluster.
id string: The ID of this resource.
name string: Name of the node.
tagline string: Elasticsearh tag line.
versions GetElasticsearchInfoVersion[]: Contains statistics about the number of nodes selected by the request's node filters.
elasticsearchConnection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.

cluster_name str: Name of the cluster, based on the Cluster name setting setting.
cluster_uuid str: Unique identifier for the cluster.
id str: The ID of this resource.
name str: Name of the node.
tagline str: Elasticsearh tag line.
versions Sequence[GetElasticsearchInfoVersion]: Contains statistics about the number of nodes selected by the request's node filters.
elasticsearch_connection GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.

clusterName String: Name of the cluster, based on the Cluster name setting setting.
clusterUuid String: Unique identifier for the cluster.
id String: The ID of this resource.
name String: Name of the node.
tagline String: Elasticsearh tag line.
versions List<Property Map>: Contains statistics about the number of nodes selected by the request's node filters.
elasticsearchConnection Property Map: Elasticsearch connection configuration block.

Supporting Types

GetElasticsearchInfoElasticsearchConnection

ApiKey string: API Key to use for authentication to Elasticsearch
BearerToken string: Bearer Token to use for authentication to Elasticsearch
CaData string: PEM-encoded custom Certificate Authority certificate
CaFile string: Path to a custom Certificate Authority certificate
CertData string: PEM encoded certificate for client auth
CertFile string: Path to a file containing the PEM encoded certificate for client auth
Endpoints List<string>
EsClientAuthentication string: ES Client Authentication field to be used with the JWT token
Headers Dictionary<string, string>: A list of headers to be sent with each request to Elasticsearch.
Insecure bool: Disable TLS certificate validation
KeyData string: PEM encoded private key for client auth
KeyFile string: Path to a file containing the PEM encoded private key for client auth
Password string: Password to use for API authentication to Elasticsearch.
Username string: Username to use for API authentication to Elasticsearch.

ApiKey string: API Key to use for authentication to Elasticsearch
BearerToken string: Bearer Token to use for authentication to Elasticsearch
CaData string: PEM-encoded custom Certificate Authority certificate
CaFile string: Path to a custom Certificate Authority certificate
CertData string: PEM encoded certificate for client auth
CertFile string: Path to a file containing the PEM encoded certificate for client auth
Endpoints []string
EsClientAuthentication string: ES Client Authentication field to be used with the JWT token
Headers map[string]string: A list of headers to be sent with each request to Elasticsearch.
Insecure bool: Disable TLS certificate validation
KeyData string: PEM encoded private key for client auth
KeyFile string: Path to a file containing the PEM encoded private key for client auth
Password string: Password to use for API authentication to Elasticsearch.
Username string: Username to use for API authentication to Elasticsearch.

apiKey String: API Key to use for authentication to Elasticsearch
bearerToken String: Bearer Token to use for authentication to Elasticsearch
caData String: PEM-encoded custom Certificate Authority certificate
caFile String: Path to a custom Certificate Authority certificate
certData String: PEM encoded certificate for client auth
certFile String: Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String: ES Client Authentication field to be used with the JWT token
headers Map<String,String>: A list of headers to be sent with each request to Elasticsearch.
insecure Boolean: Disable TLS certificate validation
keyData String: PEM encoded private key for client auth
keyFile String: Path to a file containing the PEM encoded private key for client auth
password String: Password to use for API authentication to Elasticsearch.
username String: Username to use for API authentication to Elasticsearch.

apiKey string: API Key to use for authentication to Elasticsearch
bearerToken string: Bearer Token to use for authentication to Elasticsearch
caData string: PEM-encoded custom Certificate Authority certificate
caFile string: Path to a custom Certificate Authority certificate
certData string: PEM encoded certificate for client auth
certFile string: Path to a file containing the PEM encoded certificate for client auth
endpoints string[]
esClientAuthentication string: ES Client Authentication field to be used with the JWT token
headers {[key: string]: string}: A list of headers to be sent with each request to Elasticsearch.
insecure boolean: Disable TLS certificate validation
keyData string: PEM encoded private key for client auth
keyFile string: Path to a file containing the PEM encoded private key for client auth
password string: Password to use for API authentication to Elasticsearch.
username string: Username to use for API authentication to Elasticsearch.

api_key str: API Key to use for authentication to Elasticsearch
bearer_token str: Bearer Token to use for authentication to Elasticsearch
ca_data str: PEM-encoded custom Certificate Authority certificate
ca_file str: Path to a custom Certificate Authority certificate
cert_data str: PEM encoded certificate for client auth
cert_file str: Path to a file containing the PEM encoded certificate for client auth
endpoints Sequence[str]
es_client_authentication str: ES Client Authentication field to be used with the JWT token
headers Mapping[str, str]: A list of headers to be sent with each request to Elasticsearch.
insecure bool: Disable TLS certificate validation
key_data str: PEM encoded private key for client auth
key_file str: Path to a file containing the PEM encoded private key for client auth
password str: Password to use for API authentication to Elasticsearch.
username str: Username to use for API authentication to Elasticsearch.

apiKey String: API Key to use for authentication to Elasticsearch
bearerToken String: Bearer Token to use for authentication to Elasticsearch
caData String: PEM-encoded custom Certificate Authority certificate
caFile String: Path to a custom Certificate Authority certificate
certData String: PEM encoded certificate for client auth
certFile String: Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String: ES Client Authentication field to be used with the JWT token
headers Map<String>: A list of headers to be sent with each request to Elasticsearch.
insecure Boolean: Disable TLS certificate validation
keyData String: PEM encoded private key for client auth
keyFile String: Path to a file containing the PEM encoded private key for client auth
password String: Password to use for API authentication to Elasticsearch.
username String: Username to use for API authentication to Elasticsearch.