ElasticCloud (EC) v0.10.2 published on Wednesday, Oct 2, 2024 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: ec:index/getStack:getStack
arguments:
# arguments dictionary
The following arguments are supported:
- Region string
- Region where the stack pack is. For Elastic Cloud Enterprise (ECE) installations, use
ece-region
. - Version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - Lock bool
- Lock the
latest
version_regex
obtained, 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
. - Version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - Lock bool
- Lock the
latest
version_regex
obtained, 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
. - version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - lock Boolean
- Lock the
latest
version_regex
obtained, 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
. - version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - lock boolean
- Lock the
latest
version_regex
obtained, 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.
latest
is also accepted to obtain the latest available stack version. - lock bool
- Lock the
latest
version_regex
obtained, 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
. - version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - lock Boolean
- Lock the
latest
version_regex
obtained, 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.
- Enterprise
Searches 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.
- Min
Upgradable 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
. - Upgradable
Tos List<string> - A list of stack versions which this stack version can be upgraded to.
- Version string
- The stack version
- Version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - Lock bool
- Lock the
latest
version_regex
obtained, 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
[]Get
Stack Apm - Information for APM workloads on this stack version.
- Elasticsearches
[]Get
Stack Elasticsearch - Information for Elasticsearch workloads on this stack version.
- Enterprise
Searches []GetStack Enterprise Search - Information for Enterprise Search workloads on this stack version.
- Id string
- Unique identifier of this data source.
- Kibanas
[]Get
Stack Kibana - Information for Kibana workloads on this stack version.
- Min
Upgradable 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
. - Upgradable
Tos []string - A list of stack versions which this stack version can be upgraded to.
- Version string
- The stack version
- Version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - Lock bool
- Lock the
latest
version_regex
obtained, 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<Get
Stack Apm> - Information for APM workloads on this stack version.
- elasticsearches
List<Get
Stack Elasticsearch> - Information for Elasticsearch workloads on this stack version.
- enterprise
Searches List<GetStack Enterprise Search> - Information for Enterprise Search workloads on this stack version.
- id String
- Unique identifier of this data source.
- kibanas
List<Get
Stack Kibana> - Information for Kibana workloads on this stack version.
- min
Upgradable 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
. - upgradable
Tos List<String> - A list of stack versions which this stack version can be upgraded to.
- version String
- The stack version
- version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - lock Boolean
- Lock the
latest
version_regex
obtained, 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
Get
Stack Apm[] - Information for APM workloads on this stack version.
- elasticsearches
Get
Stack Elasticsearch[] - Information for Elasticsearch workloads on this stack version.
- enterprise
Searches GetStack Enterprise Search[] - Information for Enterprise Search workloads on this stack version.
- id string
- Unique identifier of this data source.
- kibanas
Get
Stack Kibana[] - Information for Kibana workloads on this stack version.
- min
Upgradable 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
. - upgradable
Tos string[] - A list of stack versions which this stack version can be upgraded to.
- version string
- The stack version
- version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - lock boolean
- Lock the
latest
version_regex
obtained, 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[Get
Stack Apm] - Information for APM workloads on this stack version.
- elasticsearches
Sequence[Get
Stack 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[Get
Stack 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.
latest
is also accepted to obtain the latest available stack version. - lock bool
- Lock the
latest
version_regex
obtained, 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.
- enterprise
Searches 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.
- min
Upgradable 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
. - upgradable
Tos List<String> - A list of stack versions which this stack version can be upgraded to.
- version String
- The stack version
- version
Regex 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.
latest
is also accepted to obtain the latest available stack version. - lock Boolean
- Lock the
latest
version_regex
obtained, 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
- Capacity
Constraints intMax - Maximum size of the instances.
- Capacity
Constraints intMin - Minimum size of the instances.
- Compatible
Node 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.
- Docker
Image 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 []stringTypes - List of node types compatible with this one.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- Docker
Image string - Docker image to use for the APM instance.
- capacity
Constraints IntegerMax - Maximum size of the instances.
- capacity
Constraints IntegerMin - Minimum size of the instances.
- compatible
Node 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.
- docker
Image String - Docker image to use for the APM instance.
- capacity
Constraints numberMax - Maximum size of the instances.
- capacity
Constraints numberMin - Minimum size of the instances.
- compatible
Node string[]Types - List of node types compatible with this one.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- docker
Image 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.
- capacity
Constraints NumberMax - Maximum size of the instances.
- capacity
Constraints NumberMin - Minimum size of the instances.
- compatible
Node 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.
- docker
Image String - Docker image to use for the APM instance.
GetStackElasticsearch
- Capacity
Constraints intMax - Maximum size of the instances.
- Capacity
Constraints intMin - Minimum size of the instances.
- Compatible
Node List<string>Types - List of node types compatible with this one.
- Default
Plugins List<string> - List of default plugins.
- Denylists List<string>
- List of configuration options that cannot be overridden by user settings.
- Docker
Image 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.
- Capacity
Constraints intMax - Maximum size of the instances.
- Capacity
Constraints intMin - Minimum size of the instances.
- Compatible
Node []stringTypes - List of node types compatible with this one.
- Default
Plugins []string - List of default plugins.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- Docker
Image 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 IntegerMax - Maximum size of the instances.
- capacity
Constraints IntegerMin - Minimum size of the instances.
- compatible
Node List<String>Types - List of node types compatible with this one.
- default
Plugins List<String> - List of default plugins.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- docker
Image 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.
- capacity
Constraints numberMax - Maximum size of the instances.
- capacity
Constraints numberMin - Minimum size of the instances.
- compatible
Node string[]Types - List of node types compatible with this one.
- default
Plugins string[] - List of default plugins.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- docker
Image 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.
- capacity
Constraints NumberMax - Maximum size of the instances.
- capacity
Constraints NumberMin - Minimum size of the instances.
- compatible
Node List<String>Types - List of node types compatible with this one.
- default
Plugins List<String> - List of default plugins.
- denylists List<String>
- List of configuration options that cannot be overridden by user settings.
- docker
Image 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
- Capacity
Constraints intMax - Maximum size of the instances.
- Capacity
Constraints intMin - Minimum size of the instances.
- Compatible
Node 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.
- Docker
Image 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 []stringTypes - List of node types compatible with this one.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- Docker
Image string - Docker image to use for the Enterprise Search instance.
- capacity
Constraints IntegerMax - Maximum size of the instances.
- capacity
Constraints IntegerMin - Minimum size of the instances.
- compatible
Node 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.
- docker
Image String - Docker image to use for the Enterprise Search instance.
- capacity
Constraints numberMax - Maximum size of the instances.
- capacity
Constraints numberMin - Minimum size of the instances.
- compatible
Node string[]Types - List of node types compatible with this one.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- docker
Image 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.
- capacity
Constraints NumberMax - Maximum size of the instances.
- capacity
Constraints NumberMin - Minimum size of the instances.
- compatible
Node 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.
- docker
Image String - Docker image to use for the Enterprise Search instance.
GetStackKibana
- Capacity
Constraints intMax - Maximum size of the instances.
- Capacity
Constraints intMin - Minimum size of the instances.
- Compatible
Node 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.
- Docker
Image 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 []stringTypes - List of node types compatible with this one.
- Denylists []string
- List of configuration options that cannot be overridden by user settings.
- Docker
Image string - Docker image to use for the Kibana instance.
- capacity
Constraints IntegerMax - Maximum size of the instances.
- capacity
Constraints IntegerMin - Minimum size of the instances.
- compatible
Node 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.
- docker
Image String - Docker image to use for the Kibana instance.
- capacity
Constraints numberMax - Maximum size of the instances.
- capacity
Constraints numberMin - Minimum size of the instances.
- compatible
Node string[]Types - List of node types compatible with this one.
- denylists string[]
- List of configuration options that cannot be overridden by user settings.
- docker
Image 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.
- capacity
Constraints NumberMax - Maximum size of the instances.
- capacity
Constraints NumberMin - Minimum size of the instances.
- compatible
Node 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.
- docker
Image 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
ec
Terraform Provider.