ElasticCloud (EC) v0.10.5 published on Wednesday, Feb 12, 2025 by Pulumi
ec.getStack
Explore with Pulumi AI
Use this data source to retrieve information about an existing Elastic Cloud stack.
Note on regions Before you start, you might want to check the full list of regions available in Elasticsearch Service (ESS).
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ec from "@pulumi/ec";
const latest = ec.getStack({
    versionRegex: "latest",
    region: "us-east-1",
    lock: true,
});
const latestPatch = ec.getStack({
    versionRegex: "7.9.?",
    region: "us-east-1",
});
import pulumi
import pulumi_ec as ec
latest = ec.get_stack(version_regex="latest",
    region="us-east-1",
    lock=True)
latest_patch = ec.get_stack(version_regex="7.9.?",
    region="us-east-1")
package main
import (
	"github.com/pulumi/pulumi-ec/sdk/go/ec"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec.GetStack(ctx, &ec.GetStackArgs{
			VersionRegex: "latest",
			Region:       "us-east-1",
			Lock:         pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ec.GetStack(ctx, &ec.GetStackArgs{
			VersionRegex: "7.9.?",
			Region:       "us-east-1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ElasticCloud = Pulumi.ElasticCloud;
return await Deployment.RunAsync(() => 
{
    var latest = ElasticCloud.GetStack.Invoke(new()
    {
        VersionRegex = "latest",
        Region = "us-east-1",
        Lock = true,
    });
    var latestPatch = ElasticCloud.GetStack.Invoke(new()
    {
        VersionRegex = "7.9.?",
        Region = "us-east-1",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ec.EcFunctions;
import com.pulumi.ec.inputs.GetStackArgs;
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 latest = EcFunctions.getStack(GetStackArgs.builder()
            .versionRegex("latest")
            .region("us-east-1")
            .lock(true)
            .build());
        final var latestPatch = EcFunctions.getStack(GetStackArgs.builder()
            .versionRegex("7.9.?")
            .region("us-east-1")
            .build());
    }
}
variables:
  latest:
    fn::invoke:
      function: ec:getStack
      arguments:
        versionRegex: latest
        region: us-east-1
        lock: true
  latestPatch:
    fn::invoke:
      function: ec:getStack
      arguments:
        versionRegex: 7.9.?
        region: us-east-1
Using getStack
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 getStack(args: GetStackArgs, opts?: InvokeOptions): Promise<GetStackResult>
function getStackOutput(args: GetStackOutputArgs, opts?: InvokeOptions): Output<GetStackResult>def get_stack(lock: Optional[bool] = None,
              region: Optional[str] = None,
              version_regex: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetStackResult
def get_stack_output(lock: Optional[pulumi.Input[bool]] = None,
              region: Optional[pulumi.Input[str]] = None,
              version_regex: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetStackResult]func GetStack(ctx *Context, args *GetStackArgs, opts ...InvokeOption) (*GetStackResult, error)
func GetStackOutput(ctx *Context, args *GetStackOutputArgs, opts ...InvokeOption) GetStackResultOutput> Note: This function is named GetStack in the Go SDK.
public static class GetStack 
{
    public static Task<GetStackResult> InvokeAsync(GetStackArgs args, InvokeOptions? opts = null)
    public static Output<GetStackResult> Invoke(GetStackInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetStackResult> getStack(GetStackArgs args, InvokeOptions options)
public static Output<GetStackResult> getStack(GetStackArgs args, InvokeOptions options)
fn::invoke:
  function: ec:index/getStack:getStack
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Region string
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- VersionRegex string
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- Lock bool
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- Region string
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- VersionRegex string
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- Lock bool
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- region String
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- versionRegex String
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock Boolean
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- region string
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- versionRegex string
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock boolean
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- region str
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- version_regex str
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock bool
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- region String
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- versionRegex String
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock Boolean
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
getStack Result
The following output properties are available:
- Accessible bool
- To have this version accessible/not accessible by the calling user. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- Allowlisted bool
- To include/not include this version in the allowlist. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- Apms
List<Pulumi.Elastic Cloud. Outputs. Get Stack Apm> 
- Information for APM workloads on this stack version.
- Elasticsearches
List<Pulumi.Elastic Cloud. Outputs. Get Stack Elasticsearch> 
- Information for Elasticsearch workloads on this stack version.
- EnterpriseSearches List<Pulumi.Elastic Cloud. Outputs. Get Stack Enterprise Search> 
- Information for Enterprise Search workloads on this stack version.
- Id string
- Unique identifier of this data source.
- Kibanas
List<Pulumi.Elastic Cloud. Outputs. Get Stack Kibana> 
- Information for Kibana workloads on this stack version.
- MinUpgradable stringFrom 
- The minimum stack version which can be upgraded to this stack version.
- Region string
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- UpgradableTos List<string>
- A list of stack versions which this stack version can be upgraded to.
- Version string
- The stack version
- VersionRegex string
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- Lock bool
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- Accessible bool
- To have this version accessible/not accessible by the calling user. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- Allowlisted bool
- To include/not include this version in the allowlist. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- Apms
[]GetStack Apm 
- Information for APM workloads on this stack version.
- Elasticsearches
[]GetStack Elasticsearch 
- Information for Elasticsearch workloads on this stack version.
- EnterpriseSearches []GetStack Enterprise Search 
- Information for Enterprise Search workloads on this stack version.
- Id string
- Unique identifier of this data source.
- Kibanas
[]GetStack Kibana 
- Information for Kibana workloads on this stack version.
- MinUpgradable stringFrom 
- The minimum stack version which can be upgraded to this stack version.
- Region string
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- UpgradableTos []string
- A list of stack versions which this stack version can be upgraded to.
- Version string
- The stack version
- VersionRegex string
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- Lock bool
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- accessible Boolean
- To have this version accessible/not accessible by the calling user. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- allowlisted Boolean
- To include/not include this version in the allowlist. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- apms
List<GetStack Apm> 
- Information for APM workloads on this stack version.
- elasticsearches
List<GetStack Elasticsearch> 
- Information for Elasticsearch workloads on this stack version.
- enterpriseSearches List<GetStack Enterprise Search> 
- Information for Enterprise Search workloads on this stack version.
- id String
- Unique identifier of this data source.
- kibanas
List<GetStack Kibana> 
- Information for Kibana workloads on this stack version.
- minUpgradable StringFrom 
- The minimum stack version which can be upgraded to this stack version.
- region String
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- upgradableTos List<String>
- A list of stack versions which this stack version can be upgraded to.
- version String
- The stack version
- versionRegex String
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock Boolean
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- accessible boolean
- To have this version accessible/not accessible by the calling user. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- allowlisted boolean
- To include/not include this version in the allowlist. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- apms
GetStack Apm[] 
- Information for APM workloads on this stack version.
- elasticsearches
GetStack Elasticsearch[] 
- Information for Elasticsearch workloads on this stack version.
- enterpriseSearches GetStack Enterprise Search[] 
- Information for Enterprise Search workloads on this stack version.
- id string
- Unique identifier of this data source.
- kibanas
GetStack Kibana[] 
- Information for Kibana workloads on this stack version.
- minUpgradable stringFrom 
- The minimum stack version which can be upgraded to this stack version.
- region string
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- upgradableTos string[]
- A list of stack versions which this stack version can be upgraded to.
- version string
- The stack version
- versionRegex string
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock boolean
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- accessible bool
- To have this version accessible/not accessible by the calling user. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- allowlisted bool
- To include/not include this version in the allowlist. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- apms
Sequence[GetStack Apm] 
- Information for APM workloads on this stack version.
- elasticsearches
Sequence[GetStack Elasticsearch] 
- Information for Elasticsearch workloads on this stack version.
- enterprise_searches Sequence[GetStack Enterprise Search] 
- Information for Enterprise Search workloads on this stack version.
- id str
- Unique identifier of this data source.
- kibanas
Sequence[GetStack Kibana] 
- Information for Kibana workloads on this stack version.
- min_upgradable_ strfrom 
- The minimum stack version which can be upgraded to this stack version.
- region str
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- upgradable_tos Sequence[str]
- A list of stack versions which this stack version can be upgraded to.
- version str
- The stack version
- version_regex str
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock bool
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
- accessible Boolean
- To have this version accessible/not accessible by the calling user. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- allowlisted Boolean
- To include/not include this version in the allowlist. This is only relevant for Elasticsearch Service (ESS), not for ECE.
- apms List<Property Map>
- Information for APM workloads on this stack version.
- elasticsearches List<Property Map>
- Information for Elasticsearch workloads on this stack version.
- enterpriseSearches List<Property Map>
- Information for Enterprise Search workloads on this stack version.
- id String
- Unique identifier of this data source.
- kibanas List<Property Map>
- Information for Kibana workloads on this stack version.
- minUpgradable StringFrom 
- The minimum stack version which can be upgraded to this stack version.
- region String
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use ece-region.
- upgradableTos List<String>
- A list of stack versions which this stack version can be upgraded to.
- version String
- The stack version
- versionRegex String
- Regex to filter the available stacks. Can be any valid regex expression, when multiple stacks are matched through a regex, the latest version is returned. latestis also accepted to obtain the latest available stack version.
- lock Boolean
- Lock the latestversion_regexobtained, so that the new stack release doesn't cascade the changes down to the deployments. It can be changed at any time.
Supporting Types
GetStackApm  
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode List<string>Types 
- List of node types compatible with this one.
- Denylists List<string>
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the APM instance.
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode []stringTypes 
- List of node types compatible with this one.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the APM instance.
- capacityConstraints IntegerMax 
- Maximum size of the instances.
- capacityConstraints IntegerMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the APM instance.
- capacityConstraints numberMax 
- Maximum size of the instances.
- capacityConstraints numberMin 
- Minimum size of the instances.
- compatibleNode string[]Types 
- List of node types compatible with this one.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- dockerImage string
- Docker image to use for the APM instance.
- capacity_constraints_ intmax 
- Maximum size of the instances.
- capacity_constraints_ intmin 
- Minimum size of the instances.
- compatible_node_ Sequence[str]types 
- List of node types compatible with this one.
- denylists Sequence[str]
- List of configuration options that cannot be overridden by user settings.
- docker_image str
- Docker image to use for the APM instance.
- capacityConstraints NumberMax 
- Maximum size of the instances.
- capacityConstraints NumberMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the APM instance.
GetStackElasticsearch  
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode List<string>Types 
- List of node types compatible with this one.
- DefaultPlugins List<string>
- List of default plugins.
- Denylists List<string>
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the Elasticsearch cluster instances.
- Plugins List<string>
- List of available plugins to be specified by users in Elasticsearch cluster instances.
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode []stringTypes 
- List of node types compatible with this one.
- DefaultPlugins []string
- List of default plugins.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the Elasticsearch cluster instances.
- Plugins []string
- List of available plugins to be specified by users in Elasticsearch cluster instances.
- capacityConstraints IntegerMax 
- Maximum size of the instances.
- capacityConstraints IntegerMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- defaultPlugins List<String>
- List of default plugins.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the Elasticsearch cluster instances.
- plugins List<String>
- List of available plugins to be specified by users in Elasticsearch cluster instances.
- capacityConstraints numberMax 
- Maximum size of the instances.
- capacityConstraints numberMin 
- Minimum size of the instances.
- compatibleNode string[]Types 
- List of node types compatible with this one.
- defaultPlugins string[]
- List of default plugins.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- dockerImage string
- Docker image to use for the Elasticsearch cluster instances.
- plugins string[]
- List of available plugins to be specified by users in Elasticsearch cluster instances.
- capacity_constraints_ intmax 
- Maximum size of the instances.
- capacity_constraints_ intmin 
- Minimum size of the instances.
- compatible_node_ Sequence[str]types 
- List of node types compatible with this one.
- default_plugins Sequence[str]
- List of default plugins.
- denylists Sequence[str]
- List of configuration options that cannot be overridden by user settings.
- docker_image str
- Docker image to use for the Elasticsearch cluster instances.
- plugins Sequence[str]
- List of available plugins to be specified by users in Elasticsearch cluster instances.
- capacityConstraints NumberMax 
- Maximum size of the instances.
- capacityConstraints NumberMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- defaultPlugins List<String>
- List of default plugins.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the Elasticsearch cluster instances.
- plugins List<String>
- List of available plugins to be specified by users in Elasticsearch cluster instances.
GetStackEnterpriseSearch   
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode List<string>Types 
- List of node types compatible with this one.
- Denylists List<string>
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the Enterprise Search instance.
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode []stringTypes 
- List of node types compatible with this one.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the Enterprise Search instance.
- capacityConstraints IntegerMax 
- Maximum size of the instances.
- capacityConstraints IntegerMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the Enterprise Search instance.
- capacityConstraints numberMax 
- Maximum size of the instances.
- capacityConstraints numberMin 
- Minimum size of the instances.
- compatibleNode string[]Types 
- List of node types compatible with this one.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- dockerImage string
- Docker image to use for the Enterprise Search instance.
- capacity_constraints_ intmax 
- Maximum size of the instances.
- capacity_constraints_ intmin 
- Minimum size of the instances.
- compatible_node_ Sequence[str]types 
- List of node types compatible with this one.
- denylists Sequence[str]
- List of configuration options that cannot be overridden by user settings.
- docker_image str
- Docker image to use for the Enterprise Search instance.
- capacityConstraints NumberMax 
- Maximum size of the instances.
- capacityConstraints NumberMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the Enterprise Search instance.
GetStackKibana  
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode List<string>Types 
- List of node types compatible with this one.
- Denylists List<string>
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the Kibana instance.
- CapacityConstraints intMax 
- Maximum size of the instances.
- CapacityConstraints intMin 
- Minimum size of the instances.
- CompatibleNode []stringTypes 
- List of node types compatible with this one.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- DockerImage string
- Docker image to use for the Kibana instance.
- capacityConstraints IntegerMax 
- Maximum size of the instances.
- capacityConstraints IntegerMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the Kibana instance.
- capacityConstraints numberMax 
- Maximum size of the instances.
- capacityConstraints numberMin 
- Minimum size of the instances.
- compatibleNode string[]Types 
- List of node types compatible with this one.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- dockerImage string
- Docker image to use for the Kibana instance.
- capacity_constraints_ intmax 
- Maximum size of the instances.
- capacity_constraints_ intmin 
- Minimum size of the instances.
- compatible_node_ Sequence[str]types 
- List of node types compatible with this one.
- denylists Sequence[str]
- List of configuration options that cannot be overridden by user settings.
- docker_image str
- Docker image to use for the Kibana instance.
- capacityConstraints NumberMax 
- Maximum size of the instances.
- capacityConstraints NumberMin 
- Minimum size of the instances.
- compatibleNode List<String>Types 
- List of node types compatible with this one.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- dockerImage String
- Docker image to use for the Kibana instance.
Package Details
- Repository
- ec pulumi/pulumi-ec
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ecTerraform Provider.