ec.getDeployments
Explore with Pulumi AI
Use this data source to retrieve a list of IDs for the deployment and resource kinds, based on the specified query.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ElasticCloud = Pulumi.ElasticCloud;
return await Deployment.RunAsync(() =>
{
var example = ElasticCloud.GetDeployments.Invoke(new()
{
DeploymentTemplateId = "azure-compute-optimized",
Elasticsearches = new[]
{
new ElasticCloud.Inputs.GetDeploymentsElasticsearchInputArgs
{
Healthy = "true",
},
},
EnterpriseSearches = new[]
{
new ElasticCloud.Inputs.GetDeploymentsEnterpriseSearchInputArgs
{
Healthy = "true",
},
},
IntegrationsServers = new[]
{
new ElasticCloud.Inputs.GetDeploymentsIntegrationsServerInputArgs
{
Version = "8.0.0",
},
},
Kibanas = new[]
{
new ElasticCloud.Inputs.GetDeploymentsKibanaInputArgs
{
Status = "started",
},
},
NamePrefix = "test",
Size = 200,
Tags =
{
{ "foo", "bar" },
},
});
});
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.GetDeployments(ctx, &ec.GetDeploymentsArgs{
DeploymentTemplateId: pulumi.StringRef("azure-compute-optimized"),
Elasticsearches: []ec.GetDeploymentsElasticsearch{
{
Healthy: pulumi.StringRef("true"),
},
},
EnterpriseSearches: []ec.GetDeploymentsEnterpriseSearch{
{
Healthy: pulumi.StringRef("true"),
},
},
IntegrationsServers: []ec.GetDeploymentsIntegrationsServer{
{
Version: pulumi.StringRef("8.0.0"),
},
},
Kibanas: []ec.GetDeploymentsKibana{
{
Status: pulumi.StringRef("started"),
},
},
NamePrefix: pulumi.StringRef("test"),
Size: pulumi.IntRef(200),
Tags: map[string]interface{}{
"foo": "bar",
},
}, nil)
if err != nil {
return err
}
return nil
})
}
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.GetDeploymentsArgs;
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 example = EcFunctions.getDeployments(GetDeploymentsArgs.builder()
.deploymentTemplateId("azure-compute-optimized")
.elasticsearches(GetDeploymentsElasticsearchArgs.builder()
.healthy("true")
.build())
.enterpriseSearches(GetDeploymentsEnterpriseSearchArgs.builder()
.healthy("true")
.build())
.integrationsServers(GetDeploymentsIntegrationsServerArgs.builder()
.version("8.0.0")
.build())
.kibanas(GetDeploymentsKibanaArgs.builder()
.status("started")
.build())
.namePrefix("test")
.size(200)
.tags(Map.of("foo", "bar"))
.build());
}
}
import pulumi
import pulumi_ec as ec
example = ec.get_deployments(deployment_template_id="azure-compute-optimized",
elasticsearches=[ec.GetDeploymentsElasticsearchArgs(
healthy="true",
)],
enterprise_searches=[ec.GetDeploymentsEnterpriseSearchArgs(
healthy="true",
)],
integrations_servers=[ec.GetDeploymentsIntegrationsServerArgs(
version="8.0.0",
)],
kibanas=[ec.GetDeploymentsKibanaArgs(
status="started",
)],
name_prefix="test",
size=200,
tags={
"foo": "bar",
})
import * as pulumi from "@pulumi/pulumi";
import * as ec from "@pulumi/ec";
const example = ec.getDeployments({
deploymentTemplateId: "azure-compute-optimized",
elasticsearches: [{
healthy: "true",
}],
enterpriseSearches: [{
healthy: "true",
}],
integrationsServers: [{
version: "8.0.0",
}],
kibanas: [{
status: "started",
}],
namePrefix: "test",
size: 200,
tags: {
foo: "bar",
},
});
variables:
example:
fn::invoke:
Function: ec:getDeployments
Arguments:
deploymentTemplateId: azure-compute-optimized
elasticsearches:
- healthy: 'true'
enterpriseSearches:
- healthy: 'true'
integrationsServers:
- version: 8.0.0
kibanas:
- status: started
namePrefix: test
size: 200
tags:
foo: bar
Using getDeployments
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 getDeployments(args: GetDeploymentsArgs, opts?: InvokeOptions): Promise<GetDeploymentsResult>
function getDeploymentsOutput(args: GetDeploymentsOutputArgs, opts?: InvokeOptions): Output<GetDeploymentsResult>
def get_deployments(apms: Optional[Sequence[GetDeploymentsApm]] = None,
deployment_template_id: Optional[str] = None,
elasticsearches: Optional[Sequence[GetDeploymentsElasticsearch]] = None,
enterprise_searches: Optional[Sequence[GetDeploymentsEnterpriseSearch]] = None,
healthy: Optional[str] = None,
integrations_servers: Optional[Sequence[GetDeploymentsIntegrationsServer]] = None,
kibanas: Optional[Sequence[GetDeploymentsKibana]] = None,
name_prefix: Optional[str] = None,
size: Optional[int] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetDeploymentsResult
def get_deployments_output(apms: Optional[pulumi.Input[Sequence[pulumi.Input[GetDeploymentsApmArgs]]]] = None,
deployment_template_id: Optional[pulumi.Input[str]] = None,
elasticsearches: Optional[pulumi.Input[Sequence[pulumi.Input[GetDeploymentsElasticsearchArgs]]]] = None,
enterprise_searches: Optional[pulumi.Input[Sequence[pulumi.Input[GetDeploymentsEnterpriseSearchArgs]]]] = None,
healthy: Optional[pulumi.Input[str]] = None,
integrations_servers: Optional[pulumi.Input[Sequence[pulumi.Input[GetDeploymentsIntegrationsServerArgs]]]] = None,
kibanas: Optional[pulumi.Input[Sequence[pulumi.Input[GetDeploymentsKibanaArgs]]]] = None,
name_prefix: Optional[pulumi.Input[str]] = None,
size: Optional[pulumi.Input[int]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentsResult]
func GetDeployments(ctx *Context, args *GetDeploymentsArgs, opts ...InvokeOption) (*GetDeploymentsResult, error)
func GetDeploymentsOutput(ctx *Context, args *GetDeploymentsOutputArgs, opts ...InvokeOption) GetDeploymentsResultOutput
> Note: This function is named GetDeployments
in the Go SDK.
public static class GetDeployments
{
public static Task<GetDeploymentsResult> InvokeAsync(GetDeploymentsArgs args, InvokeOptions? opts = null)
public static Output<GetDeploymentsResult> Invoke(GetDeploymentsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeploymentsResult> getDeployments(GetDeploymentsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: ec:index/getDeployments:getDeployments
arguments:
# arguments dictionary
The following arguments are supported:
- Apms
List<Pulumi.
Elastic Cloud. Inputs. Get Deployments Apm> Filter by APM resource kind status or configuration.
- Deployment
Template stringId Filter the result set by the ID of the deployment template the deployment is based off.
- Elasticsearches
List<Pulumi.
Elastic Cloud. Inputs. Get Deployments Elasticsearch> Filter by Elasticsearch resource kind status or configuration.
- Enterprise
Searches List<Pulumi.Elastic Cloud. Inputs. Get Deployments Enterprise Search> Filter by Enterprise Search resource kind status or configuration.
- Healthy string
Filter the result set by their health status.
- Integrations
Servers List<Pulumi.Elastic Cloud. Inputs. Get Deployments Integrations Server> Filter by Integrations Server resource kind status or configuration.
- Kibanas
List<Pulumi.
Elastic Cloud. Inputs. Get Deployments Kibana> Filter by Kibana resource kind status or configuration.
- Name
Prefix string Prefix to filter the returned deployment list by.
- Size int
The maximum number of deployments to return. Defaults to
100
.- Dictionary<string, string>
Filter the result set by their assigned tags.
- Apms
[]Get
Deployments Apm Filter by APM resource kind status or configuration.
- Deployment
Template stringId Filter the result set by the ID of the deployment template the deployment is based off.
- Elasticsearches
[]Get
Deployments Elasticsearch Filter by Elasticsearch resource kind status or configuration.
- Enterprise
Searches []GetDeployments Enterprise Search Filter by Enterprise Search resource kind status or configuration.
- Healthy string
Filter the result set by their health status.
- Integrations
Servers []GetDeployments Integrations Server Filter by Integrations Server resource kind status or configuration.
- Kibanas
[]Get
Deployments Kibana Filter by Kibana resource kind status or configuration.
- Name
Prefix string Prefix to filter the returned deployment list by.
- Size int
The maximum number of deployments to return. Defaults to
100
.- map[string]string
Filter the result set by their assigned tags.
- apms
List<Get
Deployments Apm> Filter by APM resource kind status or configuration.
- deployment
Template StringId Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches
List<Get
Deployments Elasticsearch> Filter by Elasticsearch resource kind status or configuration.
- enterprise
Searches List<GetDeployments Enterprise Search> Filter by Enterprise Search resource kind status or configuration.
- healthy String
Filter the result set by their health status.
- integrations
Servers List<GetDeployments Integrations Server> Filter by Integrations Server resource kind status or configuration.
- kibanas
List<Get
Deployments Kibana> Filter by Kibana resource kind status or configuration.
- name
Prefix String Prefix to filter the returned deployment list by.
- size Integer
The maximum number of deployments to return. Defaults to
100
.- Map<String,String>
Filter the result set by their assigned tags.
- apms
Get
Deployments Apm[] Filter by APM resource kind status or configuration.
- deployment
Template stringId Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches
Get
Deployments Elasticsearch[] Filter by Elasticsearch resource kind status or configuration.
- enterprise
Searches GetDeployments Enterprise Search[] Filter by Enterprise Search resource kind status or configuration.
- healthy string
Filter the result set by their health status.
- integrations
Servers GetDeployments Integrations Server[] Filter by Integrations Server resource kind status or configuration.
- kibanas
Get
Deployments Kibana[] Filter by Kibana resource kind status or configuration.
- name
Prefix string Prefix to filter the returned deployment list by.
- size number
The maximum number of deployments to return. Defaults to
100
.- {[key: string]: string}
Filter the result set by their assigned tags.
- apms
Sequence[Get
Deployments Apm] Filter by APM resource kind status or configuration.
- deployment_
template_ strid Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches
Sequence[Get
Deployments Elasticsearch] Filter by Elasticsearch resource kind status or configuration.
- enterprise_
searches Sequence[GetDeployments Enterprise Search] Filter by Enterprise Search resource kind status or configuration.
- healthy str
Filter the result set by their health status.
- integrations_
servers Sequence[GetDeployments Integrations Server] Filter by Integrations Server resource kind status or configuration.
- kibanas
Sequence[Get
Deployments Kibana] Filter by Kibana resource kind status or configuration.
- name_
prefix str Prefix to filter the returned deployment list by.
- size int
The maximum number of deployments to return. Defaults to
100
.- Mapping[str, str]
Filter the result set by their assigned tags.
- apms List<Property Map>
Filter by APM resource kind status or configuration.
- deployment
Template StringId Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches List<Property Map>
Filter by Elasticsearch resource kind status or configuration.
- enterprise
Searches List<Property Map> Filter by Enterprise Search resource kind status or configuration.
- healthy String
Filter the result set by their health status.
- integrations
Servers List<Property Map> Filter by Integrations Server resource kind status or configuration.
- kibanas List<Property Map>
Filter by Kibana resource kind status or configuration.
- name
Prefix String Prefix to filter the returned deployment list by.
- size Number
The maximum number of deployments to return. Defaults to
100
.- Map<String>
Filter the result set by their assigned tags.
getDeployments Result
The following output properties are available:
- Deployments
List<Pulumi.
Elastic Cloud. Outputs. Get Deployments Deployment> List of deployments which match the specified query.
- Id string
Unique identifier of this data source.
- Return
Count int The number of deployments actually returned.
- Apms
List<Pulumi.
Elastic Cloud. Outputs. Get Deployments Apm> Filter by APM resource kind status or configuration.
- Deployment
Template stringId Filter the result set by the ID of the deployment template the deployment is based off.
- Elasticsearches
List<Pulumi.
Elastic Cloud. Outputs. Get Deployments Elasticsearch> Filter by Elasticsearch resource kind status or configuration.
- Enterprise
Searches List<Pulumi.Elastic Cloud. Outputs. Get Deployments Enterprise Search> Filter by Enterprise Search resource kind status or configuration.
- Healthy string
Filter the result set by their health status.
- Integrations
Servers List<Pulumi.Elastic Cloud. Outputs. Get Deployments Integrations Server> Filter by Integrations Server resource kind status or configuration.
- Kibanas
List<Pulumi.
Elastic Cloud. Outputs. Get Deployments Kibana> Filter by Kibana resource kind status or configuration.
- Name
Prefix string Prefix to filter the returned deployment list by.
- Size int
The maximum number of deployments to return. Defaults to
100
.- Dictionary<string, string>
Filter the result set by their assigned tags.
- Deployments
[]Get
Deployments Deployment List of deployments which match the specified query.
- Id string
Unique identifier of this data source.
- Return
Count int The number of deployments actually returned.
- Apms
[]Get
Deployments Apm Filter by APM resource kind status or configuration.
- Deployment
Template stringId Filter the result set by the ID of the deployment template the deployment is based off.
- Elasticsearches
[]Get
Deployments Elasticsearch Filter by Elasticsearch resource kind status or configuration.
- Enterprise
Searches []GetDeployments Enterprise Search Filter by Enterprise Search resource kind status or configuration.
- Healthy string
Filter the result set by their health status.
- Integrations
Servers []GetDeployments Integrations Server Filter by Integrations Server resource kind status or configuration.
- Kibanas
[]Get
Deployments Kibana Filter by Kibana resource kind status or configuration.
- Name
Prefix string Prefix to filter the returned deployment list by.
- Size int
The maximum number of deployments to return. Defaults to
100
.- map[string]string
Filter the result set by their assigned tags.
- deployments
List<Get
Deployments Deployment> List of deployments which match the specified query.
- id String
Unique identifier of this data source.
- return
Count Integer The number of deployments actually returned.
- apms
List<Get
Deployments Apm> Filter by APM resource kind status or configuration.
- deployment
Template StringId Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches
List<Get
Deployments Elasticsearch> Filter by Elasticsearch resource kind status or configuration.
- enterprise
Searches List<GetDeployments Enterprise Search> Filter by Enterprise Search resource kind status or configuration.
- healthy String
Filter the result set by their health status.
- integrations
Servers List<GetDeployments Integrations Server> Filter by Integrations Server resource kind status or configuration.
- kibanas
List<Get
Deployments Kibana> Filter by Kibana resource kind status or configuration.
- name
Prefix String Prefix to filter the returned deployment list by.
- size Integer
The maximum number of deployments to return. Defaults to
100
.- Map<String,String>
Filter the result set by their assigned tags.
- deployments
Get
Deployments Deployment[] List of deployments which match the specified query.
- id string
Unique identifier of this data source.
- return
Count number The number of deployments actually returned.
- apms
Get
Deployments Apm[] Filter by APM resource kind status or configuration.
- deployment
Template stringId Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches
Get
Deployments Elasticsearch[] Filter by Elasticsearch resource kind status or configuration.
- enterprise
Searches GetDeployments Enterprise Search[] Filter by Enterprise Search resource kind status or configuration.
- healthy string
Filter the result set by their health status.
- integrations
Servers GetDeployments Integrations Server[] Filter by Integrations Server resource kind status or configuration.
- kibanas
Get
Deployments Kibana[] Filter by Kibana resource kind status or configuration.
- name
Prefix string Prefix to filter the returned deployment list by.
- size number
The maximum number of deployments to return. Defaults to
100
.- {[key: string]: string}
Filter the result set by their assigned tags.
- deployments
Sequence[Get
Deployments Deployment] List of deployments which match the specified query.
- id str
Unique identifier of this data source.
- return_
count int The number of deployments actually returned.
- apms
Sequence[Get
Deployments Apm] Filter by APM resource kind status or configuration.
- deployment_
template_ strid Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches
Sequence[Get
Deployments Elasticsearch] Filter by Elasticsearch resource kind status or configuration.
- enterprise_
searches Sequence[GetDeployments Enterprise Search] Filter by Enterprise Search resource kind status or configuration.
- healthy str
Filter the result set by their health status.
- integrations_
servers Sequence[GetDeployments Integrations Server] Filter by Integrations Server resource kind status or configuration.
- kibanas
Sequence[Get
Deployments Kibana] Filter by Kibana resource kind status or configuration.
- name_
prefix str Prefix to filter the returned deployment list by.
- size int
The maximum number of deployments to return. Defaults to
100
.- Mapping[str, str]
Filter the result set by their assigned tags.
- deployments List<Property Map>
List of deployments which match the specified query.
- id String
Unique identifier of this data source.
- return
Count Number The number of deployments actually returned.
- apms List<Property Map>
Filter by APM resource kind status or configuration.
- deployment
Template StringId Filter the result set by the ID of the deployment template the deployment is based off.
- elasticsearches List<Property Map>
Filter by Elasticsearch resource kind status or configuration.
- enterprise
Searches List<Property Map> Filter by Enterprise Search resource kind status or configuration.
- healthy String
Filter the result set by their health status.
- integrations
Servers List<Property Map> Filter by Integrations Server resource kind status or configuration.
- kibanas List<Property Map>
Filter by Kibana resource kind status or configuration.
- name
Prefix String Prefix to filter the returned deployment list by.
- size Number
The maximum number of deployments to return. Defaults to
100
.- Map<String>
Filter the result set by their assigned tags.
Supporting Types
GetDeploymentsApm
GetDeploymentsDeployment
- Alias string
Deployment alias.
- Apm
Ref stringId The APM resource reference.
- Apm
Resource stringId The APM resource unique ID.
- Deployment
Id string The deployment unique ID.
- Elasticsearch
Ref stringId The Elasticsearch resource reference.
- Elasticsearch
Resource stringId The Elasticsearch resource unique ID.
- Enterprise
Search stringRef Id The Enterprise Search resource reference.
- Enterprise
Search stringResource Id The Enterprise Search resource unique ID.
- Integrations
Server stringRef Id The Integrations Server resource reference.
- Integrations
Server stringResource Id The Integrations Server resource unique ID.
- Kibana
Ref stringId The Kibana resource reference.
- Kibana
Resource stringId The Kibana resource unique ID.
- Name string
The name of the deployment.
- Alias string
Deployment alias.
- Apm
Ref stringId The APM resource reference.
- Apm
Resource stringId The APM resource unique ID.
- Deployment
Id string The deployment unique ID.
- Elasticsearch
Ref stringId The Elasticsearch resource reference.
- Elasticsearch
Resource stringId The Elasticsearch resource unique ID.
- Enterprise
Search stringRef Id The Enterprise Search resource reference.
- Enterprise
Search stringResource Id The Enterprise Search resource unique ID.
- Integrations
Server stringRef Id The Integrations Server resource reference.
- Integrations
Server stringResource Id The Integrations Server resource unique ID.
- Kibana
Ref stringId The Kibana resource reference.
- Kibana
Resource stringId The Kibana resource unique ID.
- Name string
The name of the deployment.
- alias String
Deployment alias.
- apm
Ref StringId The APM resource reference.
- apm
Resource StringId The APM resource unique ID.
- deployment
Id String The deployment unique ID.
- elasticsearch
Ref StringId The Elasticsearch resource reference.
- elasticsearch
Resource StringId The Elasticsearch resource unique ID.
- enterprise
Search StringRef Id The Enterprise Search resource reference.
- enterprise
Search StringResource Id The Enterprise Search resource unique ID.
- integrations
Server StringRef Id The Integrations Server resource reference.
- integrations
Server StringResource Id The Integrations Server resource unique ID.
- kibana
Ref StringId The Kibana resource reference.
- kibana
Resource StringId The Kibana resource unique ID.
- name String
The name of the deployment.
- alias string
Deployment alias.
- apm
Ref stringId The APM resource reference.
- apm
Resource stringId The APM resource unique ID.
- deployment
Id string The deployment unique ID.
- elasticsearch
Ref stringId The Elasticsearch resource reference.
- elasticsearch
Resource stringId The Elasticsearch resource unique ID.
- enterprise
Search stringRef Id The Enterprise Search resource reference.
- enterprise
Search stringResource Id The Enterprise Search resource unique ID.
- integrations
Server stringRef Id The Integrations Server resource reference.
- integrations
Server stringResource Id The Integrations Server resource unique ID.
- kibana
Ref stringId The Kibana resource reference.
- kibana
Resource stringId The Kibana resource unique ID.
- name string
The name of the deployment.
- alias str
Deployment alias.
- apm_
ref_ strid The APM resource reference.
- apm_
resource_ strid The APM resource unique ID.
- deployment_
id str The deployment unique ID.
- elasticsearch_
ref_ strid The Elasticsearch resource reference.
- elasticsearch_
resource_ strid The Elasticsearch resource unique ID.
- enterprise_
search_ strref_ id The Enterprise Search resource reference.
- enterprise_
search_ strresource_ id The Enterprise Search resource unique ID.
- integrations_
server_ strref_ id The Integrations Server resource reference.
- integrations_
server_ strresource_ id The Integrations Server resource unique ID.
- kibana_
ref_ strid The Kibana resource reference.
- kibana_
resource_ strid The Kibana resource unique ID.
- name str
The name of the deployment.
- alias String
Deployment alias.
- apm
Ref StringId The APM resource reference.
- apm
Resource StringId The APM resource unique ID.
- deployment
Id String The deployment unique ID.
- elasticsearch
Ref StringId The Elasticsearch resource reference.
- elasticsearch
Resource StringId The Elasticsearch resource unique ID.
- enterprise
Search StringRef Id The Enterprise Search resource reference.
- enterprise
Search StringResource Id The Enterprise Search resource unique ID.
- integrations
Server StringRef Id The Integrations Server resource reference.
- integrations
Server StringResource Id The Integrations Server resource unique ID.
- kibana
Ref StringId The Kibana resource reference.
- kibana
Resource StringId The Kibana resource unique ID.
- name String
The name of the deployment.
GetDeploymentsElasticsearch
GetDeploymentsEnterpriseSearch
GetDeploymentsIntegrationsServer
GetDeploymentsKibana
Package Details
- Repository
- ec pulumi/pulumi-ec
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
ec
Terraform Provider.