1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. getElasticsearchInfo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elasticstack.getElasticsearchInfo

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

    This data source provides the information about the configured Elasticsearch cluster

    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();
    
        }
    }
    
    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(id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetElasticsearchInfoResult
    def get_elasticsearch_info_output(id: Optional[pulumi.Input[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:

    Id string
    The ID of this resource.
    Id string
    The ID of this resource.
    id String
    The ID of this resource.
    id string
    The ID of this resource.
    id str
    The ID of this resource.
    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.
    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.
    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.
    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.
    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.
    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.

    Supporting Types

    GetElasticsearchInfoVersion

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    elasticstack logo
    elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic