elasticstack.getElasticsearchInfo

elasticstack 0.15.0, May 14 26

Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 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: {}

Example coming soon!

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_connections: Optional[Sequence[GetElasticsearchInfoElasticsearchConnection]] = None,
                           opts: Optional[InvokeOptions] = None) -> GetElasticsearchInfoResult
def get_elasticsearch_info_output(elasticsearch_connections: pulumi.Input[Optional[Sequence[pulumi.Input[GetElasticsearchInfoElasticsearchConnectionArgs]]]] = 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

data "elasticstack_getelasticsearchinfo" "name" {
    # arguments
}

The following arguments are supported:

ElasticsearchConnections List<GetElasticsearchInfoElasticsearchConnection>: Elasticsearch connection configuration block.

ElasticsearchConnections []GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.

elasticsearch_connections list(object): Elasticsearch connection configuration block.

elasticsearchConnections List<GetElasticsearchInfoElasticsearchConnection>: Elasticsearch connection configuration block.

elasticsearchConnections GetElasticsearchInfoElasticsearchConnection[]: Elasticsearch connection configuration block.

elasticsearch_connections Sequence[GetElasticsearchInfoElasticsearchConnection]: Elasticsearch connection configuration block.

elasticsearchConnections List<Property Map>: Elasticsearch connection configuration block.

getElasticsearchInfo Result

The following output properties are available:

ClusterName string: Name of the cluster, based on the cluster.name setting.
ClusterUuid string: Unique identifier for the cluster.
Id string: Internal identifier of the resource.
Name string: Name of the node.
Tagline string: Elasticsearch tag line.
Versions List<GetElasticsearchInfoVersion>: Contains version information for the Elasticsearch cluster.
ElasticsearchConnections List<GetElasticsearchInfoElasticsearchConnection>: Elasticsearch connection configuration block.

ClusterName string: Name of the cluster, based on the cluster.name setting.
ClusterUuid string: Unique identifier for the cluster.
Id string: Internal identifier of the resource.
Name string: Name of the node.
Tagline string: Elasticsearch tag line.
Versions []GetElasticsearchInfoVersion: Contains version information for the Elasticsearch cluster.
ElasticsearchConnections []GetElasticsearchInfoElasticsearchConnection: Elasticsearch connection configuration block.

cluster_name string: Name of the cluster, based on the cluster.name setting.
cluster_uuid string: Unique identifier for the cluster.
id string: Internal identifier of the resource.
name string: Name of the node.
tagline string: Elasticsearch tag line.
versions list(object): Contains version information for the Elasticsearch cluster.
elasticsearch_connections list(object): Elasticsearch connection configuration block.

clusterName String: Name of the cluster, based on the cluster.name setting.
clusterUuid String: Unique identifier for the cluster.
id String: Internal identifier of the resource.
name String: Name of the node.
tagline String: Elasticsearch tag line.
versions List<GetElasticsearchInfoVersion>: Contains version information for the Elasticsearch cluster.
elasticsearchConnections List<GetElasticsearchInfoElasticsearchConnection>: Elasticsearch connection configuration block.

clusterName string: Name of the cluster, based on the cluster.name setting.
clusterUuid string: Unique identifier for the cluster.
id string: Internal identifier of the resource.
name string: Name of the node.
tagline string: Elasticsearch tag line.
versions GetElasticsearchInfoVersion[]: Contains version information for the Elasticsearch cluster.
elasticsearchConnections GetElasticsearchInfoElasticsearchConnection[]: Elasticsearch connection configuration block.

cluster_name str: Name of the cluster, based on the cluster.name setting.
cluster_uuid str: Unique identifier for the cluster.
id str: Internal identifier of the resource.
name str: Name of the node.
tagline str: Elasticsearch tag line.
versions Sequence[GetElasticsearchInfoVersion]: Contains version information for the Elasticsearch cluster.
elasticsearch_connections Sequence[GetElasticsearchInfoElasticsearchConnection]: Elasticsearch connection configuration block.

clusterName String: Name of the cluster, based on the cluster.name setting.
clusterUuid String: Unique identifier for the cluster.
id String: Internal identifier of the resource.
name String: Name of the node.
tagline String: Elasticsearch tag line.
versions List<Property Map>: Contains version information for the Elasticsearch cluster.
elasticsearchConnections List<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.

api_key string: API Key to use for authentication to Elasticsearch
bearer_token string: Bearer Token to use for authentication to Elasticsearch
ca_data string: PEM-encoded custom Certificate Authority certificate
ca_file string: Path to a custom Certificate Authority certificate
cert_data string: PEM encoded certificate for client auth
cert_file string: Path to a file containing the PEM encoded certificate for client auth
endpoints list(string)
es_client_authentication 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 bool: Disable TLS certificate validation
key_data string: PEM encoded private key for client auth
key_file 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.

GetElasticsearchInfoVersion

BuildDate string: Build date.
BuildFlavor string: Build Flavor.
BuildHash string: Short hash of the last git commit in this release.
BuildSnapshot bool: Build Snapshot.
BuildType string: Build Type.
LuceneVersion string: Lucene Version.
MinimumIndexCompatibilityVersion string: Minimum index compatibility version.
MinimumWireCompatibilityVersion string: Minimum wire compatibility version.
Number string: Elasticsearch version number.

BuildDate string: Build date.
BuildFlavor string: Build Flavor.
BuildHash string: Short hash of the last git commit in this release.
BuildSnapshot bool: Build Snapshot.
BuildType string: Build Type.
LuceneVersion string: Lucene Version.
MinimumIndexCompatibilityVersion string: Minimum index compatibility version.
MinimumWireCompatibilityVersion string: Minimum wire compatibility version.
Number string: Elasticsearch version number.

build_date string: Build date.
build_flavor string: Build Flavor.
build_hash string: Short hash of the last git commit in this release.
build_snapshot bool: Build Snapshot.
build_type string: Build Type.
lucene_version string: Lucene Version.
minimum_index_compatibility_version string: Minimum index compatibility version.
minimum_wire_compatibility_version string: Minimum wire compatibility version.
number string: Elasticsearch version number.

buildDate String: Build date.
buildFlavor String: Build Flavor.
buildHash String: Short hash of the last git commit in this release.
buildSnapshot Boolean: Build Snapshot.
buildType String: Build Type.
luceneVersion String: Lucene Version.
minimumIndexCompatibilityVersion String: Minimum index compatibility version.
minimumWireCompatibilityVersion String: Minimum wire compatibility version.
number String: Elasticsearch version number.

buildDate string: Build date.
buildFlavor string: Build Flavor.
buildHash string: Short hash of the last git commit in this release.
buildSnapshot boolean: Build Snapshot.
buildType string: Build Type.
luceneVersion string: Lucene Version.
minimumIndexCompatibilityVersion string: Minimum index compatibility version.
minimumWireCompatibilityVersion string: Minimum wire compatibility version.
number string: Elasticsearch version number.

build_date str: Build date.
build_flavor str: Build Flavor.
build_hash str: Short hash of the last git commit in this release.
build_snapshot bool: Build Snapshot.
build_type str: Build Type.
lucene_version str: Lucene Version.
minimum_index_compatibility_version str: Minimum index compatibility version.
minimum_wire_compatibility_version str: Minimum wire compatibility version.
number str: Elasticsearch version number.

buildDate String: Build date.
buildFlavor String: Build Flavor.
buildHash String: Short hash of the last git commit in this release.
buildSnapshot Boolean: Build Snapshot.
buildType String: Build Type.
luceneVersion String: Lucene Version.
minimumIndexCompatibilityVersion String: Minimum index compatibility version.
minimumWireCompatibilityVersion String: Minimum wire compatibility version.
number String: Elasticsearch version number.